HESTIA Aggregation Engine

Documentation

Official documentation can be found on Read the Docs.

Additional models documentation can be found in the source folder.

Install

1. Install the module:

pip install hestia_earth.aggregation

Usage

import os
from hestia_earth.aggregation import aggregate

aggregates = aggregate(country_name='Japan')

Generating Covariance martrix

To generate the covariance matrix, some CSV files are generated and stored in a folder.

By default, these files will be created in the /tmp directory and removed at the end of aggregation, which can be changed setting the TMP_DIR env variable.

You can also choose a different storage method with the AGGREGATION_COVARIANCE_STORAGE env variable:

• temporary: default value, will store the files in the TMP_DIR and delete them at the end;
• s3#<folder>: upload the files on the S3 bucket defined by the variable AWS_BUCKET_UPLOADS;
• local#<folder>: copy the files to a local folder.