Documentation | Build |
---|---|
The documentation is built up in the following parts:
First, there is the quickstart tutorial which aims at getting you started with openaq-engine as quickly as possible. This is the right place for you if you just want to get a feel for the library or if you have never used openaq-engine before.
In case this does not suffice, we also have an API reference: API Index
If you want to develop for openaq-engine and contribute, check out our guidelines: Contribution Guidelines
Our license is available here: License
Our code of conduct is available here: Code of Conduct
Our community statement is available here: Community Statement
$ git clone git@github.com:AQ-AI/openaq-engine.git
$ cd openaq-engine
$ poetry install
$ poetry shell
$ cd openaq_engine
$ pip install -e .
$ cd ..
$ openaq-engine --help
To run the pipeline globally run:
$ openaq-engine run-pipeline /path/to/models/dir /path/to/plots/dir --cohort-table
Documentation |
---|
If at any point the documentation does not suffice, you can always get help by emailing us at info@aqai.xyz.