Getting Started

Installation

Python 3.9 is recommended for running RTC-Tools.

For most users, the easiest way to install RTC-Tools is using the pip package manager.

Using the Pip Package Manager

Although not required, it is recommended to install RTC-Tools in a virtual environment. See the official Python tutorial for more information on how to set up and activate a virtual environment.

RTC-Tools-Simulation, including its dependencies, can be installed using the pip package manager. From the command line, run:

pip install rtc-tools-simulation

Single Reservoir Modelling

Examples of how to model a single reservoir can be found in Single Reservoir Examples. First take a look at Basic Single Reservoir. This example includes a description of the file structure, auto-generation of template files, and configuring look-up tables.

Other examples within Single Reservoir Examples showcase different schemes that can be applied.

The schemes that can be applied to a single reservoir are documented in Reservoir API. Additionally, details of the underlying Modelica model can be found in Single Reservoir Model.

Lookup Tables

Details of how to create lookup tables can be found in Lookup Table.