Hestia's module to orchestrate the models.
Project description
Hestia Engine Orchestrator
Orchestrate your different models to run on a Cycle, an ImpactAssessment or a Site.
Documentation
Documentation can be found in the source folder.
Install
- Install the library:
pip install hestia_earth.orchestrator
You can now install your own models or follow the steps below to use the default Hestia models.
Install the Hestia Models
If you want to use the hestia default models, follow these steps:
- Install the library:
pip install hestia_earth.models
- Download the latest configuration files:
curl https://gitlab.com/hestia-earth/hestia-engine-orchestrator/-/raw/master/scripts/download_config.sh?inline=false -o download_config.sh && chmod +x download_config.sh
# pip default install directory is /usr/local/lib/python<version>/site-packages
./download_config.sh <pip install directory>
Using your own models
You can create your own models in addition (or instead of) the default set of models provided by Hestia.
The model needs to expose only one method:
def run(key: str, data): ...
It will be given the data that has been given to the orchestrator, i.e. by calling:
from hestia_earth.orchestrator import run
my_data = {'@type': 'Cycle', 'inputs': []}
config = {
"models": [{
"key": "inputs",
"model": "my_model",
"value": "my_model_value",
"runStrategy": "add_if_missing_key"
}]
}
run(my_data, config)
Will be calling in your own model my_model.py:
def run('my_model_value', my_data: dict): ...
Usage
# will work with either Cycle or Site
from hestia_earth.orchestrator import run
# cycle is a JSONLD node cycle
cycle = {'@type': 'Cycle', ...}
result = run(cycle, '/path/to/my-config.json') # configuration stored in a file
print(result)
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
Built Distribution
Close
Hashes for hestia-earth-orchestrator-0.6.12.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 39c4ef3d9e8b27bfbba1694295be737df50e3669b456f306f2b3105a1143a02b |
|
| MD5 | be804f6f6bfc30fa6ecfa5d81aeb5c84 |
|
| BLAKE2b-256 | 0ac009eb707fa99e068b87706998da086188b93a4a68192a743553f60086b222 |
Close
Hashes for hestia_earth_orchestrator-0.6.12-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2ea6aff28937057e8d9fa9255eab8f4898a4e14906a272c602bc36e18011028e |
|
| MD5 | 95a4cc06874e6bcfcc35e7e57559aed9 |
|
| BLAKE2b-256 | 65116b28a0addc1a896e01610f712018514f2abf728423d955b2055550fccef0 |
