pim/pg-rad
1
0
Fork 0
mirror of https://github.com/pim-n/pg-rad synced 2026-06-17 15:59:35 +02:00
Code Issues Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
Pim Nelissen
2026-06-02 17:02:09 +02:00
parent f1658ac6e0
commit 88fb739925
6 changed files with 44 additions and 101 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/quickstart.md
View File

@ -1,6 +1,6 @@
## Installation
See the [installation guide](installation.md).
See the [Installation Guide](installation.md).
## Test your installation
@ -35,6 +35,20 @@ INFO: Landscape built successfully: Example landscape
WARNING: No output produced. Use --save flag to save outputs and/or --showplots to display interactive plots.
```
Running
```
pgrad --example --show
```
should produce visual output. Running
```
pgrad --example --save
```
should create a new directory in whatever directory you ran `pgrad`, which contains the saved outputs.
## Running PG-RAD
In order to use the CLI for your own simulations, you need to provide a *config file*. To run with your config, run
@ -185,4 +199,4 @@ The easiest way to get started is to take one of these example configs, and adju
position: [0, 0, 0]
detector: dummy
```
```