From 62e1c529535352f8e6c2537eff0503fd033e4b78 Mon Sep 17 00:00:00 2001 From: jvivian Date: Sun, 21 Jul 2024 17:25:05 -0700 Subject: [PATCH] Update README to reflect `dfmdash` changes Fixes #92 --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 46a8b56..37166c0 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,17 @@ Repository for Covid-19 Dynamic Factor Model > Tested on Ubuntu, Windows WSL2: Ubuntu, and Mac OSX (M1) ## Python -- Download and install [Anaconda]() to your PATH and run: +1. Install [Poetry](https://python-poetry.org/docs/#installation) + +```bash +git clone https://github.com/jvivian/DFMDash/ # Get source code +cd DFMDash +poetry install # Install dependencies and package +c19dfm --help # Run tool's help message +``` + +## Anaconda / Mamba +- Download and install [Anaconda](https://www.anaconda.com/download) to your PATH and run: ```bash git clone https://github.com/jvivian/DFMDash/ # Get source code @@ -28,15 +38,15 @@ c19dfm --help # Run tool's help message ## Docker -`docker run jvivian/covid19-dfm` +`docker run jvivian/dfmdash` or to build locally ```bash git clone https://github.com/jvivian/DFMDash/ # Get source code cd DFMDash -docker build -t covid19-dfm . -docker run covid19-dfm +docker build -t dfmdash . +docker run dfmdash ``` # Development