HESTIA Utils
Install
- Install the module:
pip install hestia_earth.utils
- Add this to your environment variables:
API_URL=https://api.hestia.earth
WEB_URL=https://www.hestia.earth
Usage
- 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)
- 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'})
- 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')
- 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')
LSRS Format
You can use this library to convert HESTIA data into the LSRS format.
convert() accepts Impact Assessment, Cycle, Site and Source nodes and returns one
simplified dict per node:
- Impact Assessment → the 88 LSRS indicator columns plus metadata (including land transformation and deforestation read from its indicators).
- Cycle → yield, EVS, seed, pesticide, diesel, electricity, crop residues, and (using
the nutrient/unit helpers in
lsrs/models_utils.py) fertiliser kg N / kg P2O5 / kg K2O, lime kg CaCO3 and irrigation m3. - Site → site type, country, region and current land cover.
- Source → bibliography title and year.
These JSON outputs can be rendered to Excel or stored elsewhere. lsrs/models_utils.py
holds nutrient/unit/land-cover helpers copied from hestia-earth-models so this library
has no dependency on it.
For example, this will let you download all verified aggregation on HESTIA:
- Add the env variable
API_ACCESS_TOKENand use the API Key from your account. - Create a file to store the search query:
{
"bool": {
"must": [
{ "match": { "@type": "ImpactAssessment" } },
{ "match": { "aggregatedDataValidated": true } }
]
}
}
- Run
python3 convert_to_lsrs.py --query-path test.json --data-state recalculated
This will create 2 files:
query-results-lsrs.json: contains the raw JSON data needed to generate the Excel filequery-results-lsrs.xlsx: cotains the LSRS data in Excel format.
Note: if you make some changes to the Excel generation, you can run this to use the json data and re-generate the Excel file quicker: python3 render_lsrs.py --filepath query-results-lsrs.json
Converting multiple files and rendering into a single Excel
You can use the convert script to create all the JSON files containing the raw data, then render everything together at once:
- Run all your conversion, using
--skip-renderingparameter:
python3 convert_to_lsrs.py --query-path test1.json --data-state recalculated --skip-rendering
python3 convert_to_lsrs.py --query-path test1.json --data-state recalculated --skip-rendering
- This will write multiple JSON files in the
samplesfolder. Once done, render all together:python3 render_lsrs.py --folder samples. This will create the finalsamples.xlsxfile.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file hestia_earth_utils-0.17.29.tar.gz.
File metadata
- Download URL: hestia_earth_utils-0.17.29.tar.gz
- Upload date:
- Size: 100.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
585cbdc3047be3b2cb66ade4c03c8b3b070418c28c2aafc84162da4b46aaaa44
|
|
| MD5 |
967b6fe9ef462b166a15e6e5e1ced1dd
|
|
| BLAKE2b-256 |
11af9889c4384a61319caee7f3fc8ffa146859e42c0b21c0213fa7ea2764bbff
|
File details
Details for the file hestia_earth_utils-0.17.29-py3-none-any.whl.
File metadata
- Download URL: hestia_earth_utils-0.17.29-py3-none-any.whl
- Upload date:
- Size: 92.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ee7be0bd8640d2ea8689632d1dd7b83677d7ed818387d1255ed7021bb9cd61ef
|
|
| MD5 |
ea6746de9f0fd6b9f3e80e44290f02de
|
|
| BLAKE2b-256 |
2f23b054b4f1aa829352a03327e3f9b995b0103b2b2473b8231dac5f353f9a26
|
