Data Management

Output for each pygypsy command is created at a fixed path relative to a configurable output directory

The output directory can be specified after the pygypsy command and before subcommands, e.g.

pygypsy --output-dir /your/own/output-dir generate_config

This way you can manage data for several simulations

pygypsy --output-dir /lothlorien simulate /lothlorien/plot_data_prepped.csv
pygypsy --output-dir /mirkwood simulate /mirkwood/plot_data_prepped.csv
pygypsy --output-dir /mirkwood-5-year simulate /mirkwood-5-year/plot_data_prepped.csv

If it is not specified, the default output directory, ./pygypsy-output will be used.

Configuration

A configuration file is needed to run the gypsy simulation

A template configuration can be generated as follows:

pygypsy generate_config

The configuration file is a json file and must follow json syntax.

It is generally safe to replace values in the configuration files with new values of the same type (e.g. replace integers with integers).

The schema, against which the configuration file is validated, is available here.

Simulations

With the output directory and configuration file prepared, the next steps are to:

• prepare the plot data for use with pygypsy
• run the simulation on the prepared plot data

Preparing plot data

Prepare your plot data as follows

pygypsy prep --config-file ./pygypsy-output/pygypsy-config.json /path/to/your/plot-data.csv

Take note of the console output to see where the prepared plot data is created.

Running simulation

Run the gypsy simulation as follows

pygypsy simulate --config-file ./pygypsy-output/config.json /pygypsy-output/plot_data_prepped.csv

Troubleshooting

If you run into issues with pygypsy, there are a few things to check and record:

• the messages output in the terminal
• the logs for each subcommand, which are saved under the output directory

If you cannot resolve the issue based on information in those resources, open a new pygypsy issue, including the messages output by the CLI in the terminal, and the log files in the corresponding output directory.