Skip to content

FAIRDataPipeline/pySimpleModel

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

pySimpleModel

build

A simple example of an SEIRS epidemiological model using the FAIR Data Pipeline.

Installation

  1. Create and activate new python 3 virtual environment.
  2. pip install fair-cli.
  3. Install a local registry:
    1. Install graphviz
    2. fair registry install
  4. Clone this repository: git clone https://github.com/FAIRDataPipeline/pySimpleModel.git.
  5. Change directory cd pySimpleModel.
  6. Install this package pip install ..
  7. Initialise the registry fair init

Running the example

The user configuration script for running the python SEIRS model can be found inside this repo - simpleModel/ext/SEIRSconfig.yaml - and for this self-contained example, it includes all of the information to register the input data that the model needs, so that you don't have to be connected to a registry that already knows about it. The code can be executed by first ensuring that all of the input data is available in the local registry (using fair pull) and then running the code (using fair run). So:

fair pull simpleModel/ext/SEIRSconfig.yaml
fair run simpleModel/ext/SEIRSconfig.yaml

Check the output

  1. Ensure the local registry is started fair registry start.
  2. Visit the local registry in your browser (by default at http://localhost:8000), you should see the input and output data recorded in the registry.

About

Simple model example for the Python data pipeline api

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages