| Name | hestia-earth-models JSON |
| Version |
0.59.3
JSON |
| download |
| home_page | https://gitlab.com/hestia-earth/hestia-engine-models |
| Summary | Hestia's set of modules for filling gaps in the activity data using external datasets (e.g. populating soil properties with a geospatial dataset using provided coordinates) and internal lookups (e.g. populating machinery use from fuel use). Includes rules for when gaps should be filled versus not (e.g. never gap fill yield, gap fill crop residue if yield provided etc.). |
| upload_time | 2024-04-15 12:34:54 |
| maintainer | None |
| docs_url | None |
| author | Hestia Team |
| requires_python | None |
| license | GPL |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Hestia Engine Models
[](https://gitlab.com/hestia-earth/hestia-engine-models/commits/master)
[](https://gitlab.com/hestia-earth/hestia-engine-models/commits/master)
Hestia's set of models for running calculations or retrieving data using external datasets and internal lookups.
## Documentation
Documentation for every model can be found in the [Hestia API Documentation](https://hestia.earth/docs/#hestia-calculation-models).
## Install
1. Install python `3` (we recommend using python `3.6` minimum)
2. Install the module:
```bash
pip install hestia_earth.models
```
3. Set the following environment variables:
```
API_URL=https://api.hestia.earth
WEB_URL=https://hestia.earth
```
### Usage
```python
from hestia_earth.models.pooreNemecek2018 import run
# cycle is a JSONLD node Cycle
run('no3ToGroundwaterSoilFlux', cycle_data)
```
### Using Spatial Models
We have models that can gap-fill geographical information on a `Site`. If you want to use these models:
1. Install the library: `pip install hestia_earth.earth_engine`
2. Follow the [Getting Started instructions](https://gitlab.com/hestia-earth/hestia-earth-engine#getting-started).
### Using the ecoinventV3 model
ecoinvent is a consistent, transparent, and well validated life cycle inventory database.
We use ecoinvent data to ascertain the environmental impacts of activities that occur outside of our system boundary, for example data on the environmental impacts of extracting oil and producing diesel, or the impacts of manufacturing plastics.
The `ecoinventV3` model requires a valid [license](https://ecoinvent.org/offerings/licences/) to run. We are currently working on a way to enable users of this code with a valid ecoinvent licence to run these models themselves, but for now, these models are only available on the public platform.
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/hestia-earth/hestia-engine-models",
"name": "hestia-earth-models",
"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/4e/05/1f4266d91b0c5c218f11f2af5529cb8b76144344f3e6a8733651fac94ae5/hestia-earth-models-0.59.3.tar.gz",
"platform": null,
"description": "# Hestia Engine Models\n\n[](https://gitlab.com/hestia-earth/hestia-engine-models/commits/master)\n[](https://gitlab.com/hestia-earth/hestia-engine-models/commits/master)\n\nHestia's set of models for running calculations or retrieving data using external datasets and internal lookups.\n\n## Documentation\n\nDocumentation for every model can be found in the [Hestia API Documentation](https://hestia.earth/docs/#hestia-calculation-models).\n\n## Install\n\n1. Install python `3` (we recommend using python `3.6` minimum)\n2. Install the module:\n```bash\npip install hestia_earth.models\n```\n3. Set the following environment variables:\n```\nAPI_URL=https://api.hestia.earth\nWEB_URL=https://hestia.earth\n```\n\n### Usage\n\n```python\nfrom hestia_earth.models.pooreNemecek2018 import run\n\n# cycle is a JSONLD node Cycle\nrun('no3ToGroundwaterSoilFlux', cycle_data)\n```\n\n### Using Spatial Models\n\nWe have models that can gap-fill geographical information on a `Site`. If you want to use these models:\n1. Install the library: `pip install hestia_earth.earth_engine`\n2. Follow the [Getting Started instructions](https://gitlab.com/hestia-earth/hestia-earth-engine#getting-started).\n\n### Using the ecoinventV3 model\n\necoinvent is a consistent, transparent, and well validated life cycle inventory database.\nWe use ecoinvent data to ascertain the environmental impacts of activities that occur outside of our system boundary, for example data on the environmental impacts of extracting oil and producing diesel, or the impacts of manufacturing plastics.\n\nThe `ecoinventV3` model requires a valid [license](https://ecoinvent.org/offerings/licences/) to run. We are currently working on a way to enable users of this code with a valid ecoinvent licence to run these models themselves, but for now, these models are only available on the public platform.\n\n\n",
"bugtrack_url": null,
"license": "GPL",
"summary": "Hestia's set of modules for filling gaps in the activity data using external datasets (e.g. populating soil properties with a geospatial dataset using provided coordinates) and internal lookups (e.g. populating machinery use from fuel use). Includes rules for when gaps should be filled versus not (e.g. never gap fill yield, gap fill crop residue if yield provided etc.).",
"version": "0.59.3",
"project_urls": {
"Homepage": "https://gitlab.com/hestia-earth/hestia-engine-models"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f4809f63bbafb6de15d2d33f23dee803c762b819a8508d8d478f1b490655e5de",
"md5": "22267db44b41d06e4a600930d24172c1",
"sha256": "8ce0755e475bf64acd5883d0266e98b1dbca04e249c77089eb26378971cf4a9b"
},
"downloads": -1,
"filename": "hestia_earth_models-0.59.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "22267db44b41d06e4a600930d24172c1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 870522,
"upload_time": "2024-04-15T12:34:50",
"upload_time_iso_8601": "2024-04-15T12:34:50.916258Z",
"url": "https://files.pythonhosted.org/packages/f4/80/9f63bbafb6de15d2d33f23dee803c762b819a8508d8d478f1b490655e5de/hestia_earth_models-0.59.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4e051f4266d91b0c5c218f11f2af5529cb8b76144344f3e6a8733651fac94ae5",
"md5": "f342d3887b46b41818bd1448c263746e",
"sha256": "afe45b447aa0d3ad5c86fe5bb455b54aba4318c993cacbf5481633af5aaf9d1d"
},
"downloads": -1,
"filename": "hestia-earth-models-0.59.3.tar.gz",
"has_sig": false,
"md5_digest": "f342d3887b46b41818bd1448c263746e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 295463,
"upload_time": "2024-04-15T12:34:54",
"upload_time_iso_8601": "2024-04-15T12:34:54.679194Z",
"url": "https://files.pythonhosted.org/packages/4e/05/1f4266d91b0c5c218f11f2af5529cb8b76144344f3e6a8733651fac94ae5/hestia-earth-models-0.59.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-15 12:34:54",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "hestia-earth",
"gitlab_project": "hestia-engine-models",
"lcname": "hestia-earth-models"
}
