Commit 84e5967f authored by Eric Duminil's avatar Eric Duminil
Browse files

Added help

parent f34d5150
......@@ -61,6 +61,31 @@ If no project path is specified, workflows are run in a temporary repository und
# Print detected SimStadt installation path and version
simstadt
# See help
simstadt --help
usage: simstadt [-h] [--gui] [--csv-export] [--install] [-d DESCRIPTION] [--destination DESTINATION] [-p PROJECT_PATH] [-f] [-s PATH] [-v] [template] [citygml]
simstadt - Python library for SimStadt workflows.
positional arguments:
template Template name (from SIMSTADT_TEMPLATE_PATH) or path to a .flow directory.
citygml Path to the CityGML input file.
options:
-h, --help show this help message and exit
--gui Launch the SimStadt GUI.
--csv-export Export CSV from workflowsteps, when available.
--install Download and install the latest SimStadt release to ~/Desktop.
-d DESCRIPTION, --description DESCRIPTION
Human-readable label for the result.
--destination DESTINATION
Workflow folder name (default: timestamped random id).
-p PROJECT_PATH, --project-path PROJECT_PATH
Directory where the workflow folder is created.
-f, --files Show output files after the run.
-s PATH, --save PATH Save result DataFrame to a file (.csv or .json).
-v, --verbose Enable debug logging.
# Download and install the latest SimStadt release to ~/Desktop
simstadt --install
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment