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

Uploaded Source

Built Distribution

hestia_earth_models-0.64.4-py3-none-any.whl (995.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hestia-earth-models-0.64.4.tar.gz
  • Upload date:
  • Size: 363.4 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.4.tar.gz
Algorithm Hash digest
SHA256 8cf7b850002cef065136522ca452e94328da0def3dea02206abd9825f3eead5a
MD5 7ad55263a4bcc120704f8a24f3046a1e
BLAKE2b-256 346bb580867f54159f2071aa9ea1467dad2ab8d91713da1b796815c0e7af317c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for hestia_earth_models-0.64.4-py3-none-any.whl
Algorithm Hash digest
SHA256 3cea3189f62354fc7a60c87080d0186d0dc973a8ffb2bc906828bc9596126639
MD5 8442dab3c25e21d4facad7455e25d412
BLAKE2b-256 1911913dd5a24f55c2194da3e92dd4c931ea3f9a187d7a561d4ea1a43436be98

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