Skip to main content

HESTIA Converters

Library to convert from/to the HESTIA format.

Quick start

Install the base library and the converter you need. Each converter is its own install extra, so you only pull the dependencies of the formats you use:

pip install hestia-earth-converters
pip install "hestia-earth-converters[SimaPro]"

hestia-convert --help is generated from the converters you installed, so it always lists exactly the formats and options available to you.

# a HESTIA ImpactAssessment, downloaded by id, as a SimaPro CSV
hestia-convert --output-folder out --input-format HESTIA --output-format SimaPro \
  --hestia-impact-id cocoaSeedWhole-ghana-2010-2025-20250916

# a file on disk, converted to HESTIA nodes
hestia-convert --output-folder out --input-format OpenLCA --output-format HESTIA \
  --input-file export.zip

Some data needs an API key, as does downloading any node with --hestia-impact-id. Create an account, copy the key from the "API Access" section of https://www.hestia.earth/profile, and set it as the API_ACCESS_TOKEN environment variable.

Where no converter goes straight from one format to another, the CLI runs the pair that does, by way of HESTIA. So every input format reaches LSRS:

hestia-convert --output-folder out --input-format Klim --output-format LSRS \
  --input-file farm.zip

runs Klim -> HESTIA, then HESTIA -> LSRS over what it wrote. The intermediate HESTIA files stay in --output-folder — they are output too, and they are what makes a chained run debuggable. --filter-by-name names a result of the first leg, and the rest of the chain sees only what it selected.

These flags apply to every conversion. Each converter adds more of its own, prefixed with its name; its README lists them.

Flag Description
--output-folder Output files folder (required)
--input-format Format to read (required)
--output-format Format to write (required)
--input-file Path to the input file
--hestia-impact-id One or more HESTIA ImpactAssessment ids to download and convert
--mapping-files-directory Folder of .csv mapping files (default: hestia-flowmaps, downloaded if absent)
--skip-existing Do not overwrite files already written
--filter-by-name Names to filter results on (in quotes)
--verbose Verbose logging
--debug-file Write conversion logs to a debug file

Converters

Format Directions Install extra Docs
Cool Farm Platform Cool Farm ⇄ HESTIA [CoolFarm] README
Farm Carbon Calculator FCC ⇄ HESTIA [FCC] README
KLIM Klim → HESTIA [Klim] README
LSRS reporting spreadsheet HESTIA → LSRS [LSRS] README
openLCA openLCA ⇄ HESTIA, openLCA → LSRS [OpenLCA] README
SimaPro HESTIA → SimaPro [SimaPro] README

Term mappings come from hestia-convert-flowmaps, downloaded automatically unless --mapping-files-directory points elsewhere. Errors and omissions in a mapping belong in an issue on that repository.

Adding a converter? See CONVERTER_BLUEPRINT.md. Contributing? See CONTRIBUTING.md.

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_converters-0.2.3.tar.gz (244.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hestia_earth_converters-0.2.3-py3-none-any.whl (319.9 kB view details)

Uploaded Python 3

File details

Details for the file hestia_earth_converters-0.2.3.tar.gz.

File metadata

  • Download URL: hestia_earth_converters-0.2.3.tar.gz
  • Upload date:
  • Size: 244.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.12.14

File hashes

Hashes for hestia_earth_converters-0.2.3.tar.gz
Algorithm Hash digest
SHA256 6ba6d427096f80ad381511adfe3fc5e2b85b01c63107d1a4c4ee787432ab6b29
MD5 daecf0b6f06cf915d253811162414b37
BLAKE2b-256 d97ba39862f8bf3a72e9a7d47876c31bb57b9bce0ab7dbe37ee0f30c68229356

See more details on using hashes here.

File details

Details for the file hestia_earth_converters-0.2.3-py3-none-any.whl.

File metadata

File hashes

Hashes for hestia_earth_converters-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 fa2e641b38565bdb5c8d705e9ce7622549a14d11d6a51434116eac6a22ef9b30
MD5 2a90c4e3cfe800298b625f013890633c
BLAKE2b-256 4155e972ae24de5405b60bb25a2d9807462ad0bc7e21ba197d8480d0ddea8ffc

See more details on using hashes here.

Release history Release notifications | RSS feed

0.2.8

2 files

0.2.7

2 files

0.2.6

2 files

0.2.5

2 files

0.2.4

2 files

This release

0.2.3 This release

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.0

2 files

0.0.6

2 files

0.0.4

2 files

0.0.2

2 files

0.0.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page