hestia-earth-aggregation

Name	hestia-earth-aggregation JSON
Version	0.20.20 JSON
	download
home_page	https://gitlab.com/hestia-earth/hestia-aggregation-engine
Summary	HESTIA's aggregation engine.
upload_time	2025-09-05 11:40:15
maintainer	None
docs_url	None
author	HESTIA Team
requires_python	None
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # HESTIA Aggregation Engine

[![Pipeline Status](https://gitlab.com/hestia-earth/hestia-aggregation-engine/badges/master/pipeline.svg)](https://gitlab.com/hestia-earth/hestia-aggregation-engine/commits/master)
[![Coverage Report](https://gitlab.com/hestia-earth/hestia-aggregation-engine/badges/master/coverage.svg)](https://gitlab.com/hestia-earth/hestia-aggregation-engine/commits/master)
[![Documentation Status](https://readthedocs.org/projects/hestia-aggregation-engine/badge/?version=latest)](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

os.environ['API_URL'] = 'https://api.hestia.earth'
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, which can be changed setting the `TMP_DIR` env variable.



            

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": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "HESTIA Team",
    "author_email": "guillaumeroyer.mail@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/89/8b/f228bbea473950a3aaff183368d922546c38466b61d99fd846b058bed3ee/hestia_earth_aggregation-0.20.20.tar.gz",
    "platform": null,
    "description": "# HESTIA Aggregation Engine\n\n[![Pipeline Status](https://gitlab.com/hestia-earth/hestia-aggregation-engine/badges/master/pipeline.svg)](https://gitlab.com/hestia-earth/hestia-aggregation-engine/commits/master)\n[![Coverage Report](https://gitlab.com/hestia-earth/hestia-aggregation-engine/badges/master/coverage.svg)](https://gitlab.com/hestia-earth/hestia-aggregation-engine/commits/master)\n[![Documentation Status](https://readthedocs.org/projects/hestia-aggregation-engine/badge/?version=latest)](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\nos.environ['API_URL'] = 'https://api.hestia.earth'\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, which can be changed setting the `TMP_DIR` env variable.\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "HESTIA's aggregation engine.",
    "version": "0.20.20",
    "project_urls": {
        "Homepage": "https://gitlab.com/hestia-earth/hestia-aggregation-engine"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "9421a93abffc930596c7366f863dfc638c3100a96e681c8b222b764ef1957683",
                "md5": "f8b3ad74afd99e3805277d2d654e9d8e",
                "sha256": "f677cf7adde0305580d4779fb49643a4b539d49713610314acab65199ba39cb1"
            },
            "downloads": -1,
            "filename": "hestia_earth_aggregation-0.20.20-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f8b3ad74afd99e3805277d2d654e9d8e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 62348,
            "upload_time": "2025-09-05T11:40:14",
            "upload_time_iso_8601": "2025-09-05T11:40:14.935003Z",
            "url": "https://files.pythonhosted.org/packages/94/21/a93abffc930596c7366f863dfc638c3100a96e681c8b222b764ef1957683/hestia_earth_aggregation-0.20.20-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "898bf228bbea473950a3aaff183368d922546c38466b61d99fd846b058bed3ee",
                "md5": "13c27d17c6d48e0e22f2e5b285d30f94",
                "sha256": "bb5a0a363be2f6b16f72b99e4c30d3f23535105ab7b5edf9bd43acdbb6bf1a11"
            },
            "downloads": -1,
            "filename": "hestia_earth_aggregation-0.20.20.tar.gz",
            "has_sig": false,
            "md5_digest": "13c27d17c6d48e0e22f2e5b285d30f94",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 45976,
            "upload_time": "2025-09-05T11:40:15",
            "upload_time_iso_8601": "2025-09-05T11:40:15.975426Z",
            "url": "https://files.pythonhosted.org/packages/89/8b/f228bbea473950a3aaff183368d922546c38466b61d99fd846b058bed3ee/hestia_earth_aggregation-0.20.20.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-05 11:40:15",
    "github": false,
    "gitlab": true,
    "bitbucket": false,
    "codeberg": false,
    "gitlab_user": "hestia-earth",
    "gitlab_project": "hestia-aggregation-engine",
    "lcname": "hestia-earth-aggregation"
}