| Name | hestia-earth-models JSON |
| Version |
0.51.1
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 | 2023-09-25 12:51:37 |
| maintainer | |
| docs_url | None |
| author | Hestia Team |
| requires_python | |
| 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 thse 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 Ecoinvent 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.
To include these data in your environmental impact assessments using Hestia, you must own a suitable [ecoinvent license](https://ecoinvent.org/offerings/licences/).
Please contact us at community@hestia.earth for instructions to download the required file to run the model.
Once downloaded, copy the file in the _hestia_earth/models/data/ecoinventV3_ folder.
Thank you!
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/hestia-earth/hestia-engine-models",
"name": "hestia-earth-models",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Hestia Team",
"author_email": "guillaumeroyer.mail@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/41/b6/f5ed614137c8e4c8d2275bf9dfec25537a548d9a096328080a10608f07c6/hestia-earth-models-0.51.1.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`.\nIf you want to use thse 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 Ecoinvent 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.\nTo include these data in your environmental impact assessments using Hestia, you must own a suitable [ecoinvent license](https://ecoinvent.org/offerings/licences/).\n\nPlease contact us at community@hestia.earth for instructions to download the required file to run the model.\nOnce downloaded, copy the file in the _hestia_earth/models/data/ecoinventV3_ folder.\nThank you!\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.51.1",
"project_urls": {
"Homepage": "https://gitlab.com/hestia-earth/hestia-engine-models"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dca4ee461d7aaac2f2f4725f7c29ba44befd2fd5d23d8ff0b0d5a70c9107b091",
"md5": "e617d7ee986c4fcf38c9321b36e42f4f",
"sha256": "48865a530e01a72d1a60dcb230e1c6406e114e47aadeb63ef9fdc8af91ca1a6b"
},
"downloads": -1,
"filename": "hestia_earth_models-0.51.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e617d7ee986c4fcf38c9321b36e42f4f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 755146,
"upload_time": "2023-09-25T12:51:34",
"upload_time_iso_8601": "2023-09-25T12:51:34.577339Z",
"url": "https://files.pythonhosted.org/packages/dc/a4/ee461d7aaac2f2f4725f7c29ba44befd2fd5d23d8ff0b0d5a70c9107b091/hestia_earth_models-0.51.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "41b6f5ed614137c8e4c8d2275bf9dfec25537a548d9a096328080a10608f07c6",
"md5": "9f087f9133fdaca05cb02e8896b79174",
"sha256": "b94823c2fb05313678b920c25df1b279ac1feaf4820313e89ce6355b0c079eeb"
},
"downloads": -1,
"filename": "hestia-earth-models-0.51.1.tar.gz",
"has_sig": false,
"md5_digest": "9f087f9133fdaca05cb02e8896b79174",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 212548,
"upload_time": "2023-09-25T12:51:37",
"upload_time_iso_8601": "2023-09-25T12:51:37.060175Z",
"url": "https://files.pythonhosted.org/packages/41/b6/f5ed614137c8e4c8d2275bf9dfec25537a548d9a096328080a10608f07c6/hestia-earth-models-0.51.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-25 12:51:37",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "hestia-earth",
"gitlab_project": "hestia-engine-models",
"lcname": "hestia-earth-models"
}
