README.md

IRENA FlexTool is an energy and power systems model for understanding the role of variable power generation in future energy systems. It performs capacity expansion planning as well as operational planning.

This is IRENA FlexTool v3.0 in beta testing. Report any bugs or difficulties in the issue tracker. The previous version of IRENA FlexTool can be found in https://www.irena.org/energytransition/Energy-System-Models-and-Data/IRENA-FlexTool.

User guide and documentation are under development, but the current version can be found at https://irena-flextool.github.io/flextool/.

Getting started

Main alternatives to use IRENA FlexTool

• Use a browser: IRENA FlexTool can be accessed with a web browser if you have an account for an IRENA FlexTool server. However, no public servers available at the moment. The browser interface is shown below.
• Local server: It is possible to setup a local server and then use a browser to access that server. See https://github.com/irena-flextool/flextool-web-interface
• Install a front-end: Install Spine Toolbox and run IRENA FlexTool as a Spine Toolbox project. This gives you the graphical user interface of Spine Toolbox. https://github.com/Spine-project/Spine-Toolbox

Connecting to IRENA FlexTool server

Instruction will be added later. The interface is shown below.

Installing Spine Toolbox and IRENA FlexTool on a local computer

• Install Miniconda (or Anaconda) [Can be ignored if already installed]
• Start Anaconda prompt
• Create new Python environment [Also possible to use existing, up-to-date, Spine Toolbox environment]

  conda create -n flextool python=3.8

• Activate the environment

  conda activate flextool

• Install Git to the environment [Also possible to use existing Git installation]

  conda install git

• cd to a directory into which both FlexTool and Spine Toolbox will make their own folders
• Clone the FlexTool Git repository

  git clone https://github.com/irena-flextool/flextool

• Install Spine Toolbox [Can be skipped if using existing Toolbox environment]
  • Clone the Toolbox repository

    git clone https://github.com/Spine-project/Spine-Toolbox.git

  • cd to the freshly created folder

    cd Spine-Toolbox

  • Make sure Pip is up-to-date

    python -m pip install --upgrade pip

  • Install packages required by Toolbox

    python -m pip install -r requirements.txt

• Launch Spine Toolbox

  python -m spinetoolbox

• Open FlexTool3 project in Spine Toolbox (Choose the flextool folder from File > Open project dialog)

In case of problems when installing Spine Toolbox, more instructions are available at: https://github.com/Spine-project/Spine-Toolbox#installation

Run

1. Open a conda prompt.
2. Activate the environment

conda activate flextool

3. Launch Spine Toolbox

python -m spinetoolbox

4. Open FlexTool3 project in Spine Toolbox (Choose the flextool folder from File > Open project dialog)

Next steps

Learn about the basic data structure (important for understanding the model): Spine database.

If using FlexTool with Spine Toolbox, learn how the Spine Toolbox workflow functions: Spine Toolbox workflow.

If using FlexTool with a web-browser, read how it works: Browser interface.

Finally, go to the documentation of the model itself: FlexTool tutorial and documentation.

Updating IRENA FlexTool

Update of IRENA FlexTool to the latest version is done as follows

• Start anaconda prompt
• conda activate flextool (or whatever is your conda environment name for IRENA FlexTool)
• cd to the FlexTool directory
• git restore . (THIS WILL DELETE YOUR LOCAL CHANGES TO THE FILES IN THE WORKFLOW. This will be improved in the future. Currently you can work around this by making your own input files (Excel or SQLite) and pointing the workflow items (Excel_input_data or Input_Data) to your own files instead of the input_data.sqlite or FlexTool_import_template.xlsx.)
• git pull