Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nebfield authored May 9, 2024
1 parent 959eb68 commit bee25b6
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions pyvatti/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# pyvatti

pyvatti is a FastAPI application for launching PGS Catalog Calculator jobs in different environments.

## Installation

```bash
$ git clone https://github.com/ebi-gdp/hattivatti.git
$ cd hattivatti/pyvatti
$ poetry install
```

## Usage

```bash
$ fastapi src/pyvatti/main.py
```

## Configuration

`pyvatti` requires some environment variables to be set. See [src/pyvatti/config.py](https://github.com/ebi-gdp/hattivatti/blob/main/pyvatti/src/pyvatti/config.py)

## Developer notes

* The most important class is [`PolygenicScoreJob`](https://github.com/ebi-gdp/hattivatti/blob/main/pyvatti/src/pyvatti/job.py), which inherits from an asynchronous state machine class [provided by transitions](https://github.com/pytransitions/transitions)
* Triggering changes to state causes [compute resources](https://github.com/ebi-gdp/hattivatti/blob/main/pyvatti/src/pyvatti/resources.py) to be created or destroyed, or notifications to be sent to the backend.
* Everything else is pretty standard for a FastAPI application

0 comments on commit bee25b6

Please sign in to comment.