From e23d679439770ab37f106eee86f9e3287ee0f8af Mon Sep 17 00:00:00 2001 From: Felipe Montealegre-Mora <34276401+felimomo@users.noreply.github.com> Date: Tue, 9 Jul 2024 15:52:41 -0700 Subject: [PATCH] Update README.md --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 55b5cd4..fb85536 100644 --- 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 +```