Installation

Development Installation using conda (recommended)

To install, clone the repository in your computer by using git or downloading it. Example using git and http:

git clone https://gitlab.com/dlr-ve/autumn.git

Change to the directory by running the following if you are still in the directory where the package was cloned:

cd autumn

conda env create -f environment.yml

Warning

If you install using this method you don’t need to install Geopandas and Cartopy Independently, the package manager does it for you.

Setting up (Post installation)

Before you can start using the data you should do some preparations. First activate the newly installed environment running:

conda activate autumn_env

Then download the data using the provided script:

python -m autumn.scripts.create_data_tree

Warning

Sometimes you may get an error related to outdated ssl certificates. The roots of this problem are still unknown but it can be avoided by closing the terminal and launching it again in Linux and MacOS systems and by restarting the computer in Windows systems.

Once the dependencies are installed, the background operations have to be fulfilled, to do so, import the api using:

python -m autumn.core

You should get a message like this:

2020-11-30 14:02:20 INFO     Starting harmonization
2020-11-30 14:02:23 INFO     Calculating cost values
2020-11-30 14:02:23 INFO     Creating power plant input file
2020-11-30 14:02:29 INFO     Creating power plant cost potential file
2020-11-30 14:02:36 INFO     Creating iron and steel cost potential file
2020-11-30 14:02:36 INFO     Creating cement cost potential file

Using Jupyter Notebooks

Jupyter notebooks are a powerful and popular data analysis tool. Once the installation of the dependencies is successful you can use them natively with a caveat. You need to work from the root directory of the repository. You can achieve this by launching jupyter from this location. Jupyter lab is already included in the conda dependencies but not in the pip ones.

If you want to add the created environment to an existing jupyter installation run:

conda activate autumn_env
python -m ipykernel install --user --name autumn_env

Building a distribution package

The repository is package ready, because of administrative reasons we haven’t been able to put it in the PyPI but you can build it from source by going to the repository directory and running:

python setup.py sdist bdist_wheel

Once done, navigate to the dist folder with your activated conda environment and run

pip install <your_local_file_location>/autumncpc-0.1.0.tar.gz

This will make the package available as a normal Python package.

pip installation

Before you install using this method please notice that you will need at least a working installation of geopandas for most of the features. The recommended way of getting it is by installing via conda, please refer to the Geopandas documentation . This project was built using geopandas 0.8.1

Map features require also a working installation of cartopy, this can be also easily satisfied using conda, please refer to the Cartopy documentation . Version: 0.18.0.

If you want to go for pip, go to the directory and run:

pip install -r requirements.txt