TNO Intern

Commit 6c370546 authored by Zanne Korevaar's avatar Zanne Korevaar
Browse files

Update CLI manual with with statement for batch run command from the simulation directory.

parent 05c4f61e
Loading
Loading
Loading
Loading
+8 −6
Original line number Diff line number Diff line
@@ -71,7 +71,7 @@ Generates and plots a time-profile of flow rates.
geoloop stochastic-run CONFIG.json
```

Creates plots of simulation results (e.g. temperature-depth profiles, time-plots of system variables)
Creates plots of simulation results (e.g. temperature-depth profiles, time-plots of system variables).

---

@@ -87,6 +87,9 @@ geoloop batch --help
Geoloop batch provides commands to build batch configuration JSON files and to execute the batch script. Note: all
batch commands come with their own --help method.

The batch commands should be executed from the directory where the batch configuration JSON and linked configuration commands
are stored. For an example, see [Simple Simulation](../examples/simple_simulation/simple_simulation.md). 

## Creating batch Configuration Files

### A. Using `batch create`
@@ -95,11 +98,10 @@ This method generates a batch JSON by specifying steps explicitly, for example:

```bash
geoloop batch create batch.json \
    --process-lithology path/to/lithology.json \
    --calculate-loadprofile path/to/loadprofile.json \
    --single-run path/to/simulation.json \
    --plot path/to/plot.json
  
    --process-lithology lithology.json \
    --calculate-loadprofile loadprofile.json \
    --single-run simulation.json \
    --plot plot.json
```

Each flag adds a new step.