# HESTIA Aggregation Engine
[](https://gitlab.com/hestia-earth/hestia-aggregation-engine/commits/master)
[](https://gitlab.com/hestia-earth/hestia-aggregation-engine/commits/master)
[](https://hestia-aggregation-engine.readthedocs.io/en/latest/?badge=latest)
## Documentation
Official documentation can be found on [Read the Docs](https://hestia-aggregation-engine.readthedocs.io/en/latest/index.html).
Additional models documentation can be found in the [source folder](./hestia_earth/aggregation).
## Install
1. Install the module:
```bash
pip install hestia_earth.aggregation
```
### Usage
```python
import os
from hestia_earth.aggregation import aggregate
aggregates = aggregate(country_name='Japan')
```
## Generating Covariance martrix
To generate the covariance matrix, some CSV files are generated and stored in a folder.
By default, these files will be created in the `/tmp` directory and removed at the end of aggregation, which can be changed setting the `TMP_DIR` env variable.
You can also choose a different storage method with the `AGGREGATION_COVARIANCE_STORAGE` env variable:
- `temporary`: default value, will store the files in the `TMP_DIR` and delete them at the end;
- `s3#<folder>`: upload the files on the S3 bucket defined by the variable `AWS_BUCKET_UPLOADS`;
- `local#<folder>`: copy the files to a local folder.
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/hestia-earth/hestia-aggregation-engine",
"name": "hestia-earth-aggregation",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": null,
"author": "HESTIA Team",
"author_email": "guillaumeroyer.mail@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c2/4d/0d9c666df9f1a78592553cfffa6c9144ad527ec041c6d9cc7e962b6f21d9/hestia_earth_aggregation-0.21.0.tar.gz",
"platform": null,
"description": "# HESTIA Aggregation Engine\n\n[](https://gitlab.com/hestia-earth/hestia-aggregation-engine/commits/master)\n[](https://gitlab.com/hestia-earth/hestia-aggregation-engine/commits/master)\n[](https://hestia-aggregation-engine.readthedocs.io/en/latest/?badge=latest)\n\n## Documentation\n\nOfficial documentation can be found on [Read the Docs](https://hestia-aggregation-engine.readthedocs.io/en/latest/index.html).\n\nAdditional models documentation can be found in the [source folder](./hestia_earth/aggregation).\n\n## Install\n\n1. Install the module:\n```bash\npip install hestia_earth.aggregation\n```\n\n### Usage\n\n```python\nimport os\nfrom hestia_earth.aggregation import aggregate\n\naggregates = aggregate(country_name='Japan')\n```\n\n## Generating Covariance martrix\n\nTo generate the covariance matrix, some CSV files are generated and stored in a folder.\n\nBy default, these files will be created in the `/tmp` directory and removed at the end of aggregation, which can be changed setting the `TMP_DIR` env variable.\n\nYou can also choose a different storage method with the `AGGREGATION_COVARIANCE_STORAGE` env variable:\n- `temporary`: default value, will store the files in the `TMP_DIR` and delete them at the end;\n- `s3#<folder>`: upload the files on the S3 bucket defined by the variable `AWS_BUCKET_UPLOADS`;\n- `local#<folder>`: copy the files to a local folder.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "HESTIA's aggregation engine.",
"version": "0.21.0",
"project_urls": {
"Homepage": "https://gitlab.com/hestia-earth/hestia-aggregation-engine"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "910d3f8637bd8ecb79c7b307150e2d66b7e8f3e8eb740a59f8b9ec438e25f21f",
"md5": "a517ea5f457cb14b487bf04c42bbdb61",
"sha256": "30cc0b3e89c40810b48d3a6f955a4899ae18dfc821fa0cc5e78375b853a2d44b"
},
"downloads": -1,
"filename": "hestia_earth_aggregation-0.21.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a517ea5f457cb14b487bf04c42bbdb61",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 51770,
"upload_time": "2025-10-16T10:51:20",
"upload_time_iso_8601": "2025-10-16T10:51:20.955668Z",
"url": "https://files.pythonhosted.org/packages/91/0d/3f8637bd8ecb79c7b307150e2d66b7e8f3e8eb740a59f8b9ec438e25f21f/hestia_earth_aggregation-0.21.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c24d0d9c666df9f1a78592553cfffa6c9144ad527ec041c6d9cc7e962b6f21d9",
"md5": "43b065eb48360fefc602ce63fcb727df",
"sha256": "0fc121abb622ac8e829ef3f2fe23ec3896a1ffef6e34f1b9498f4aa4291658b8"
},
"downloads": -1,
"filename": "hestia_earth_aggregation-0.21.0.tar.gz",
"has_sig": false,
"md5_digest": "43b065eb48360fefc602ce63fcb727df",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 40269,
"upload_time": "2025-10-16T10:51:22",
"upload_time_iso_8601": "2025-10-16T10:51:22.330006Z",
"url": "https://files.pythonhosted.org/packages/c2/4d/0d9c666df9f1a78592553cfffa6c9144ad527ec041c6d9cc7e962b6f21d9/hestia_earth_aggregation-0.21.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-16 10:51:22",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "hestia-earth",
"gitlab_project": "hestia-aggregation-engine",
"lcname": "hestia-earth-aggregation"
}
JSON