Skip to content

Backend API for MAEP process management.

License

Notifications You must be signed in to change notification settings

maep-tools/maep-backend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MAEP is a collection of tools for operation planning of power systems.
MAEP web interface is a tool for manage the optimization models of MAEP. This tool is an open-source application of free access through a web environment.

MAEP Backend System

MAEP's backend system was build using Laravel. Laravel is a web application framework with expressive, elegant syntax. Laravel attempts to take the pain out of development by easing common tasks used in the majority of web projects. You need to config the .env file that contains the environment variables of the configurations of the system (Databases, email, queue configuration)

Tecnology to install in your server:

PHP >= 7.1
APACHE >= 2.2.9
MYSQL 5.5
REDIS >= 3.0.2
NODE >= 8.9.1
PM2 >= 2.10.1
SUPERVISORD >= 3.3.3
PYTHON >= 3.0.0

It´s important to know the installation process of a Laravel app. Also you need to know how to install nodejs scripts.

Deployment

If you need to deploy this please check this documentation. https://laravel.com/docs/5.5/deployment

Permissions

Es necesario que el backend cuente con todos los permisos en la carpeta storage y en la carpeta bootstrap para ello ejecutamos:

chmod -R 777 ./storage ./bootstrap`

Config the max size in the php.ini config.

upload_max_filesize = 40M
post_max_size = 40M

Redis

sudo systemctl enable redis-server

Python Libraries

Install Anaconda If you need info about how to install Anaconda in Linux: https://www.anaconda.com/download/#linux

You need to download de installer using curl or wget and then execute.

curl -O https://repo.continuum.io/archive/Anaconda3-5.0.1-Linux-x86_64.sh

then

bash Anaconda3-5.0.1-Linux-x86_64.sh

For obtain the python3 path

which python3

Gurobi needs to be installed in your server:

conda install -c gurobi gurobi

You need to have a gurobi license. http://www.gurobi.com/documentation/8.0/quickstart_mac/obtaining_a_gurobi_license.html

Exec this command in your command line for install the python packages.

pip3 install numpy scipy pyomo progressbar

Migrations

You need to create a database called laracog in a mysql database. This command will create the tables in the database. Execute: php artisan migrate

For more information about migrations: https://laravel.com/docs/5.5/migrations

Seeds

The application comes with preconfigured registers. If you need execute this please insert this command:

php artisan db:seed

If you need more information: https://laravel.com/docs/5.5/seeding

Workers

Change the number of Workers in the supervisord.conf

[program:queue]
process_name=%(program_name)s_%(process_num)02d
command=php /var/www/maep_back/artisan --timeout=0 queue:work
autostart=true
autorestart=true
numprocs=1
redirect_stderr=true
stderr_logfile=/var/www/maep_back/laraqueue.supervisord_out.log
stdout_logfile=/var/www/maep_back/laraqueue.supervisord_out.log

NodeJS realtime features:

If you want realtime features in the software:

In the socket folder:

npm install
pm2 start main.js
pm2 save

You need also supervisor for supervise the queues. http://supervisord.org/running.html

If you are in a development environment you can run in the path of the folder:

php artisan queue:work

License


MIT Copyright 2018 MAEP

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Releases

No releases published

Packages

No packages published