Commit 49597a99 authored by Martin Bergemann's avatar Martin Bergemann
Browse files

Add new help message as the example

parent be7d5302
......@@ -76,7 +76,7 @@ An example configuration can be found in [config.toml](https://gitlab.dkrz.de/m3
The pipeline can be applied using the ```da-pipeline``` command:
```bash
$: da-pipeline --help
usage: run_pipeline [-h] [-a ADDRESS ADDRESS ADDRESS] [-nb NOTE_BOOK] config
usage: run_pipeline [-h] [-a ADDRESS ADDRESS ADDRESS] [-nb NOTE_BOOK] [--begin BEGIN] [--no_slurm] config
Apply data pipeline.
......@@ -86,12 +86,12 @@ positional arguments:
optional arguments:
-h, --help show this help message and exit
-a ADDRESS ADDRESS ADDRESS, --address ADDRESS ADDRESS ADDRESS
Give a tcp address to a distributed scheduler
(default: (None, None, None))
Give a tcp address to a distributed scheduler (default: (None, None, None))
-nb NOTE_BOOK, --note-book NOTE_BOOK, --notebook NOTE_BOOK
Chose notebook for visualization (default:
~/.anaconda3/lib/python3.7/site-pac
kages/da_pipeline/da_pipeline/scripts/PlotData.ipynb)
Chose notebook for visualization (default: ~/workspace/da_pipeline/da_pipeline/scripts/PlotData.ipynb)
--begin BEGIN Choose begin time of the job, only applicable with slurm jobs (default: now)
--no_slurm, --no-slurm, --noslurm
Do not submit the pipeline jobs via slurm, rather start a background job (default: False)
```
......@@ -119,4 +119,4 @@ Since the process is running in the background, you can log out and check the st
> **_Note:_** The [papermill library](https://papermill.readthedocs.io/en/latest/usage-parameterize.html) that applies the notebook in batch mode will look for notebook cells tagged with ```injected-parameters``` and replace the ```sim_config_file``` and ```scheduler_address``` variables. Hence if you're planning to change the notebook or run a whole new one you should design its content that it'll be configured with this two parameters. Also the output filenames of the visualisation files should comply with what is expected by the java-script frontend (https://gitlab.dkrz.de/m300765/da_pipeline_frontend).
\ No newline at end of file
Markdown is supported
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