Usage

Running the Code

All the available options and configurations can be found, along with their explanation, in the config.yaml file. Type hints for all of the different options are included in the comments. To run Spaceborne using this configuration file, activate the previously created spaceborne environment and simply run:

$ python main.py

If you want to use a configuration file with a different name and/or path, you can do it with

$ python main.py --config=<path_to_config_file>

for example:

$ python main.py --config="path/to/my/config/config.yaml"

To display the plots generated by the code, add the --show-plots flag:

$ python main.py --config="path/to/my/config/config.yaml" --show-plots

Keep in mind that quite a large amount of plots will be generated in this case.