Update README.md

boettiger-lab · Jul 9, 2024 · e23d679 · e23d679
1 parent a530489
commit e23d679
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -7,3 +7,21 @@ A DRL-based approach to Caribou conservation based on the methods of the
 
 A three-species foodweb is considered, including interactions between Caribou, Elk and Wolf populations.
 
+## Installation
+
+```
+git clone https://github.com/boettiger-lab/rl4caribou.git
+cd rl4caribou
+pip install .
+```
+## Train an agent
+
+```
+python scripts/train.py -f path/to/config/file.yml -id "string saving id" [-pb if you want a progress bar displayed]
+```
+
+An quick example:
+
+```
+python scripts/train.py -f hyperpars/example.yml -id "my_first_agent" -pb
+```