inretensys-fastapi

What is it?

inretensys-fastapi is an api which is based on FastAPI to connect a graphical user interface with the inretensys-backend.

This repository is part of the software package "inretensys-open-plan-gui" which is a fork of the open_plan-gui.

Differences to open_plan-gui

This package is the backend of the software package. It runs the interface to simulate und optimize generated energymodels from the graphical user interface.

It can run as a standalone interface or as part of an docker compose structure.

Installation and Start

Standalone interface

To run inretensys-fastapi follow these steps.

• create a virtual environment for python (version > 3.8)

  $ python3 -m venv venv
  $ source venv/bin/activate
  

• install the requirements

  $ pip install -r requirements.txt
  

  For the following steps you need an energysystem as binary or json file. How you generate these files please see inretensys-backend.

• start the api with the following command to get an overview

  $ uvicorn api.api:app --reload #for debugging
  

  After this step the webinterface is started and you can use the displayed link in your command line window.

Docker compose

If you want to use docker to run the sofware package "InRetEnsys" it recommend to see the inretensys-common repository. This repository contains all needed information.