The module calculates the forecast energy demand for a defined geographical area. The result output includes the energy-related sectors (households; industry; traffic; commerce, trade and services).
...
The documentation of the source code can be found locally in folder docs/_build/html/index.html Please open with it within a browser.
Creating a bookmark within the browser can help you find the documentation more quickly when used often.
If you intend to further develop the software, please install the git version control system first. In Linux distributions, git can be installed via the package manager. For Windows, go to http://git-scm.com/. Remark: At step "Adjusting your PATH environment", select "Run Git from the Windows Command Prompt".
Then, in a directory of your choice, clone this repository by:
git clone https://github.com/LarissaBreuning/endemo.git
A better way to clone repositories is to use a password-protected SSH key. See the Github documentation on how to add an SSH key to your account.
Continue at “Installation of endemo” below.
If you do not intend to further develop the software, pick the latest release and download the zip file.
We recommend using the Python distribution Anaconda or Mamba. If you don't want to use it or already have an existing Python (version 3.10 recommended) installation, you can also download the required packages by yourself.
- Anaconda (Python 3)/Mamba Choose the 64-bit installer if possible.
During the installation procedure, keep both checkboxes "modify PATH" and "register Python" selected! If only higher Python versions are available, you can switch to a specific Python Version by typing
conda install python=<version> - Packages
- Download the environment file endemo-env.yml.
- Launch a new command prompt (Windows: Win+R, type "cmd", Enter / Linux: CTRL+Alt+T)
- Install it via conda or mamba by
conda env create -f endemo-env.yml. - Each time you open a new terminal for running endemo, you can activate the environment by
conda activate endemo. - At first run, you may have to init conda or mamba by running
conda init
Continue at Get Started.
For all packages, best take the latest release or release candidate version. Both 32 bit and 64 bit versions work, though 64 bit is recommended. The list of packages can be found in the environment file endemo-env.yml.
After installation, got to the directory you downloaded or cloned endemo into and execute the script main.py by using the following on the command prompt (Windows) or Terminal (Linux) : python main.py.
The results will be stored in the folder output.