Project page: https://github.com/open-plan-tool/simulation-server
Developed by Reiner Lemoine Institut in the scope of the open_plan project.
The open-plan-tool simulation-server runs energy model optimization on demand and returns optimal solution, if any. An example architecture in which this simulation-sever is provided on the following picture
The open-plan-tool/gui sends simulation requests to a simulation server so that you can queue tasks and still use the app while the simulation to be done. The server can be running on your local computer, or you can set it up online. An online server hosted by Reiner Lemoine Institut is setup by default for open-plan-tool/gui
The code in this repository creates the simulation server and a basic server API to dispatch mvs simulation tasks to a queue of workers. The API typically receives a post request with a json input file, sends this file to a parser which initiate an MVS simulation. Once the simulation is done, a json response is sent back. The json results can also be retrieved with the task id.
This project is licensed under `GNU AFFERO GENERAL PUBLIC LICENSE. See the LICENSE file for details.
You need to be able to run docker-compose commands, the simpler might be to install docker desktop
Run sudo docker-compose up -d --build to run the task queue and the webapp simultaneously.
Now the webapp is available at 127.0.0.1:5001
Use
sudo docker-compose logs web
to get the logs messages of the web service of the docker-compose.yml file
Run sudo docker-compose down to shut the services down.
There are many possible configurations in which you can use the simulation server together with the open_plan gui.
- You can do a fully local deploy of both the GUI and server
- You can also deploy the server online and link your locally deployed GUI to it
- At last, you can deploy online both the server and the GUI
Once you ran the docker-compose command from [Get started menu](#Get started) above,
you should be able to visit http://127.0.0.1:5001 and see a page where you can upload json files to start a simulation.
The MVS_HOST_API environment variable in open-plan GUI should then be set as MVS_HOST_API=http://127.0.0.1:5001 (see the instructions to deploy open-plan GUI for more help).
The open-plan GUI can be then deployed locally and will run simulations on your local simulation server :)
You need first to have access to online services to host the server (eg. one of those listed in https://geekflare.com/docker-hosting-platforms/). You might need to adapt the docker-compose.yml file to be able to access the docker container on a subdomain of your service provider. You can then visit a URL to see the page equivalent to http://127.0.0.1:5001 in [above section](#local deploy of the server). You need to link your open-plan gui to this URL.
NOTE
In that case open-plan can be deployed both locally or online.
NOTE
open-plan GUI does not need to be deployed on the same service provider as the open-plan server.
Using redis
Ubuntu install instructions
sudo apt update
sudo apt install redis-server
Then go in redis conf file
sudo nano /etc/redis/redis.conf
and look for supervised parameter, set it to systemd
supervised systemd
Then start the service with
sudo systemctl restart redis.service
or
sudo service redis-server start
(to stop it use sudo service redis-server stop)
Move to task_queue and run . setup_redis.sh to start the celery queue with redis a message
broker.
Using RabbitMQ
Using fastapi
In another terminal go the the root of the repo and run . fastapi_run.sh
Now the fastapi app is available at 127.0.0.1:5001
To build the docs simply go to the docs folder
cd docs
Install the requirements
pip install -r docs_requirements.txt
and run
make html
The output will then be located in docs/_build/html and can be opened with your favorite browser
Use black . to lint the python files inside the repo