Welcome to openaq-engine’s documentation!

The documentation is build 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 get a feel for the library or if you never used openaq-engine before.

In case this does not suffice, we also have an API reference, the Module Index.

If you want to develop for openaq-engine and contribute, check out our guidelines in: Contributing

Our license is in: BSD 3-Clause License

Our code of conduct is in: Code of Conduct

Our community statement is in: Community Statement

Quick answer:

$ git clone git@github.com:AQ-AI/openaq-engine.git
$ poetry install

Remember to define your psql environment variables and export them using:

$ source .env

Long answer: We keep more detailed installation instructions (including dependencies) up-to-date below

If at any point the documentation does not suffice, you can always get help by mailing at info@aqai.xyz

Contents:

• BSD 3-Clause License
• Contributing
  • Commit messages
  • Commit types
  • Code standards
  • Sending pull requests
• Code of Conduct
  • Reporting Guidelines:
• Community Statement
  • Hello All. Welcome to our community!
  • Vision Statement
  • Mission Statement
• AWS Prerequisites
  • AWS Account
  • Terraform Installed
  • AWS CLI Installed & IAM User with Permissions
  • SSH Key Pair
  • Authentication with AWS
• Connecting to EC2
  • Configure AWS
  • Adding new user
• Terraform Setup for AWS EC2 Instance
  • Setup your AWS Environments before using Terraform
  • Terraform Code to Initialize AWS EC2 Instance
  • Initialize Terraform
  • Apply the Terraform Configuration
  • Destroy the EC2 Instance
  • Find the Latest Amazon Machine Image (AMI)
• Local Postgres setup
  • Create Postgres User and database;
• Docker setup
  • Adding aws ssh keypair to github repos
  • Add user to docker group
  • Executing docker
• Environment Variables
  • Environment Variables
  • Obtaining Environment Variables
  • Setting Environment Variables
• Local Environment Setup
  • Setting up pyenv
  • Install dependenies
• How To Install Grafana
  • Step 1: Create an IAM Role and Policy
  • Step 2: Create a Security Group
  • Step 3: Create EC2 Instance
  • Step 4: Install Grafana
  • Test Grafana
  • Using Grafana
• AQAI Pipeline
  • Overview
  • Data Sources
  • AQAI.DB
  • AQAI.FLOW
  • AQAI.Board
  • VPC (Virtual Private Cloud)
  • Integration
• AQAI Database Schema
  • Cohorts Table
  • Features Table
  • Model Metadata Table
  • Results Table
• Mlflow Experiment Implementation
  • Backend/Model Deployment
  • Methodology
  • Example: Extending the Library
• Building and Deploying Sphinx Documentation from Scratch
  • Workflow Overview
  • Steps Breakdown
  • Additional Notes

---

we also have an API reference, the Module Index.

Indices and tables

• Index

• Module Index

• Search Page