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 is a JSONLD node Cycle
run('no3ToGroundwaterSoilFlux', cycle_data)

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 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.64.8.tar.gz (382.3 kB view details)

Uploaded Source

Built Distribution

hestia_earth_models-0.64.8-py3-none-any.whl (1.0 MB view details)

Uploaded Python 3

File details

Details for the file hestia-earth-models-0.64.8.tar.gz.

File metadata

  • Download URL: hestia-earth-models-0.64.8.tar.gz
  • Upload date:
  • Size: 382.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for hestia-earth-models-0.64.8.tar.gz
Algorithm Hash digest
SHA256 ec42c35bc51e0db6f305ac2488295f4ce24b3b39bb42b156787d8bcb014effdc
MD5 6bf1a5f7afdb06787ca0a918fa3184de
BLAKE2b-256 203b8c16918666651069f92b4b4d9de83c7b385b7acff78b899244e8c5801db0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for hestia_earth_models-0.64.8-py3-none-any.whl
Algorithm Hash digest
SHA256 830032c905eb3bcda9887efffda0568d992d65d9dfa18a512a711cf51e4a9001
MD5 bf93201d397efb04ccd3fbaa97d2cddc
BLAKE2b-256 a5f25bea097857495ac58ab74c7fcf0bf16cc52d58bf1c8f977e7cee7fd0b475

See more details on using hashes here.

Supported by

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