Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README to reflect dfmdash changes #95

Merged
merged 1 commit into from
Jul 22, 2024
Merged

Update README to reflect dfmdash changes #95

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
Loading