Skip to content

Installation

Requirements

  • Python 3.11 or higher
  • pip (Python package installer)

Install from PyPI

pip install aeolus-aq

Optional Extras

Some data sources and features require optional dependencies that are not installed by default:

Extra Install command Provides
openaq pip install aeolus-aq[openaq] OpenAQ portal access (wraps the official openaq SDK)
purpleair pip install aeolus-aq[purpleair] PurpleAir portal access
stats pip install aeolus-aq[stats] statsmodels for deseasonalisation in trend()
progress pip install aeolus-aq[progress] tqdm progress bars for bulk downloads
all pip install aeolus-aq[all] All of the above (OpenAQ + PurpleAir + stats)

Conda users: conda install -c conda-forge aeolus_aq installs the core package; then pip install openaq purpleair-api statsmodels tqdm for the optional sources and features.

Install from Source

For the latest development version:

git clone https://github.com/southlondonscientific/aeolus.git
cd aeolus
pip install -e .

Development Installation

If you want to contribute to Aeolus, install with development dependencies:

git clone https://github.com/southlondonscientific/aeolus.git
cd aeolus
pip install -e ".[dev]"

This includes pytest and other testing tools.

Verify Installation

import aeolus
print(aeolus.__version__)

Next Steps