Skip to content

Commit

Permalink
info
Browse files Browse the repository at this point in the history
  • Loading branch information
AngryMaciek committed Mar 8, 2024
1 parent def922b commit ed634d2
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,11 @@ We have prepared a dedicated [conda environment](https://docs.conda.io/projects/
bash prepare-environments.sh
```

5. Finally, feel free to verify the installation with a small test script
```bash
bash testscript.sh
```

## Configuration

For a detailed description of all available simulation parameters please inspect [GitHub repository](https://github.com/robjohnnoble/demon_model) of the core _demon_ model.
Expand Down Expand Up @@ -117,12 +122,6 @@ Running large workflows with hundreds of cluster jobs might take very long; cons
After each pipeline run the main output directory will contain three subdirectories: `configfiles`, `simulations` and `logs`. Each simulation run with a specific set of parameters is encoded by a 4-letter code. The first directory contains configuration files for each of the simulation runs; `simulations` contain all _demon_ output files; `logs` keep captured standard output and error streams for the commands.
## Example
Feel free to run the pipeline and inspect the results yourself in an [interactive jupyter notebook](https://mybinder.org/v2/gh/AngryMaciek/warlock/master?labpath=notebook.ipynb) we prepared.
Alternatively, feel free to run a small test script on your local machine with
`bash testscript.sh`.
## Community guidelines
For guidelines on how to contribute to the project or report issues, please see [contributing instructions](/CONTRIBUTING.md).
For other inquires feel free to contact project lead by email: [✉️](mailto:wsciekly.maciek@gmail.com)
Expand Down

0 comments on commit ed634d2

Please sign in to comment.