Skip to main content

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.).

Project description

HESTIA Engine Models

Pipeline Status Coverage Report

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.

Install

  1. Install python 3 (we recommend using python 3.6 minimum)
  2. Install the module:
pip install hestia_earth.models
  1. Set the following environment variables:
API_URL=https://api.hestia.earth
WEB_URL=https://hestia.earth

Usage

from hestia_earth.models.pooreNemecek2018 import run

cycle_data = {"@type": "Cycle", ...}
# cycle is a JSONLD node Cycle
result = run('no3ToGroundwaterSoilFlux', cycle_data)
print(result)

This will display only the result of the no3ToGroundwaterSoilFlux model (Emission).

Additionally, to reduce the number of queries to the HESTIA API and run the models faster, prefetching can be enabled:

from hestia_earth.models.preload_requests import enable_preload

enable_preload()

Using the orchestrator

The models come with an "orchestrator", which allows you to run a pre-configured set of models instead of a single one.

The configuration for each Node (Cycle, Site or ImpactAssessment) can be found in the config folder.

Usage:

from hestia_earth.orchestrator import run
from hestia_earth.models.config import load_config

cycle_data = {"@type": "Cycle", ...}
result = run(cycle, load_config(cycle))
print(result)

This will display the Cycle recalculated with all HESTIA default models running.

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.

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 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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hestia_earth_models-0.73.2.tar.gz (468.1 kB view details)

Uploaded Source

Built Distribution

hestia_earth_models-0.73.2-py3-none-any.whl (1.1 MB view details)

Uploaded Python 3

File details

Details for the file hestia_earth_models-0.73.2.tar.gz.

File metadata

  • Download URL: hestia_earth_models-0.73.2.tar.gz
  • Upload date:
  • Size: 468.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.23

File hashes

Hashes for hestia_earth_models-0.73.2.tar.gz
Algorithm Hash digest
SHA256 f25392c35ebf285c3d6cfc6a661e2e811d11e3b35b57249c5ba21934c17c38a8
MD5 41c8ca03bbd7e4473f02e95e63f43afa
BLAKE2b-256 90a83ab031cae06be94ae2f1834ebdfc7b95ed7f77246a64ed372b6e71dee780

See more details on using hashes here.

File details

Details for the file hestia_earth_models-0.73.2-py3-none-any.whl.

File metadata

File hashes

Hashes for hestia_earth_models-0.73.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3a6ddc2c7da550d377788de4d74c1c5c44f3862d69cd2e171e0587bc13847990
MD5 e0c77aeee0cf1c1e9747f6e2b60913b7
BLAKE2b-256 7648eb7848cdb73266ac5496b91bea8349c8836c1890702d6def7063d47ecdf4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page