Usage¶
Run the model¶
All interactions with YETI use the script run_yeti.py
. Run the script on the command line:
python -m run_yeti
. Make sure to run the script from the
repository root directory.
run_yeti.py
uses a configuration file in YAML format
where a Strategy
for the emission calculation method is defined together with all the necessary input/output file
locations and other parameters.
You may specify the location of the config file: python -m run_yeti -c path/to/config.yaml
.
If you don’t specify a location for the config file explicitly, the path ./config.yaml
is used.
Look here
for more detailed information what should be included in the config file.
You can pass the argument -q
to run YETI in quiet mode: python -m run_yeti -q
. In quiet mode no DEBUG information
will be displayed.
Run python -m run_yeti --help
for short usage information.
Output of a model run are one or multiple emissions csv files and a file run_info.txt
.
All output files will be in the output_folder
that you specify in the configuration file.
Run the tests¶
We include Python unit tests to test most of the YETI code. If you modified the code and want to see if it still works, you may want to execute the tests. Note that the tests are also run on our test server (Travis CI)automatically every time someone pushes to the GitHub repository.
Execute the tests by running make test
on the command line from the repository root
directory.
Note that GNU Make needs to be installed on your computer for
this to work. If you don’t have GNU Make installed, you can run the tests with
python -m unittest tests/*/test*.py tests/test*.py
.