hestia-earth-utils

HESTIA Utils

Install

1. Install the module:

pip install hestia_earth.utils

1. Add this to your environment variables:

API_URL=https://api.hestia.earth
WEB_URL=https://www.hestia.earth

Usage

1. To download a file from the HESTIA API:

from hestia_earth.schema import SchemaType
from hestia_earth.utils.api import download_hestia

cycle = download_hestia('cycleId', SchemaType.CYCLE)
sandContent = download_hestia('sandContent', SchemaType.TERM)

1. To search for a specific Node on HESTIA:

from hestia_earth.schema import SchemaType
from hestia_earth.utils.api import find_node_exact

source = find_node_exact(SchemaType.SOURCE, {'bibliography.title': 'My Bibliography'})

1. To get a lookup table from local file system:

from hestia_earth.schema import SchemaType
from hestia_earth.utils.lookup import load_lookup

df = load_lookup('path/to/my/lookup.csv')

1. To get a lookup table from HESTIA:

from hestia_earth.schema import SchemaType
from hestia_earth.utils.lookup import download_lookup

df = download_lookup('crop.csv')