Installation

Recommended Installation

The recommended way to install GLAES is to use the conda package manager. This will ensure that all dependencies are installed correctly and that the package is compatible with your system.

Using the conda package manager of your choice (we recommend miniforge), you can install GLAES with the following command:

conda install -c conda-forge glaes

If you are installing GLAES into an environment using an environment.yml file, make sure to add the conda-forge channel to the file:

channels:
  - conda-forge
dependencies:
  - conda-forge::glaes

Note

conda and mamba can be used interchangeably in all commands below.

Development Installation

GLAES is closely linked to GeoKit. If you intend to develop GLAES, it is also recommended to install GeoKit in development mode into the same environment.

1. Clone a local copy of both repositories:

   git clone https://github.com/FZJ-IEK3-VSA/glaes.git
   git clone https://github.com/FZJ-IEK3-VSA/geokit.git
   

2. Combine the dependencies from GLAES's requirements-no-geokit.yml and GeoKit's requirements.yml into a new requirements-combined.yml. GLAES ships a dedicated requirements-no-geokit.yml that intentionally omits the conda-forge geokit package, so it does not shadow the editable GeoKit you install from source in step 5.

3. Create the new environment with all conda-forge dependencies:

   conda env create --file requirements-combined.yml -n glaes_dev_env
   

4. Activate the environment:

   conda activate glaes_dev_env
   

5. Install both libraries in editable mode:

   pip install -e ./geokit --no-deps
   pip install -e ./glaes --no-deps