Skip to content

Install instructions #30

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+3 −13
Open

Install instructions #30

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
16 changes: 3 additions & 13 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -4,26 +4,16 @@

A simple example of an SEIRS epidemiological model using the [FAIR Data Pipeline](https://fairdatapipeline.github.io).

## Installing the command line tools
## Installing the command line tools and local registry

If you don't already have the registry initialised and the `fair` command line tool configured, then you need to install that next - see [here](https://github.com/FAIRDataPipeline/FAIR-CLI#installation) for more details. Briefly, with python and poetry (`pip install poetry`) installed:


```sh
git clone https://github.com/FAIRDataPipeline/FAIR-CLI.git
cd FAIR-CLI
poetry install
poetry shell
```

You are now running in a new shell created by `poetry` that has a copy of the `fair` executable in its path.
Follow [Instructions to install the CLI](https://github.com/FAIRDataPipeline/FAIR-CLI#installation) in the [CLI GitHub repository](https://github.com/FAIRDataPipeline/FAIR-CLI), then follow the instructions to [install the Data Registry via the CLI](https://github.com/FAIRDataPipeline/FAIR-CLI#registry).

## Installing the R API and simple model functions

Install the [`rDataPipeline`](https://github.com/FAIRDataPipeline/rDataPipeline) package, in R:

```R
install.packages(devtools)
install.packages("devtools")
devtools::install_github("FAIRDataPipeline/rDataPipeline")
library(rDataPipeline)
```