Package: omegalpes
OMEGAlpes Lib for linear energy systems modellingOMEGAlpesstands for Generation of Optimization Models As Linear Programming for Energy Systems.OMEGAlpesaims to be an energy systems modelling tool for linear optimisation (LP, MILP).Aweb interfaceis available athttps://mhi-srv.g2elab.grenoble-inp.fr/OMEGAlpes-web-front-end/to generate scriptsWe are happy that you will use or develop the OMEGAlpes library.It is anOpen Sourceproject located on GitLab athttps://gricad-gitlab.univ-grenoble-alpes.fr/omegalpes/omegalpesProject PresentationOMEGAlpes library :Please have a look to OMEGAlpes presentation :https://omegalpes.readthedocs.io/en/latest/The library is available at:https://gricad-gitlab.univ-grenoble-alpes.fr/omegalpes/omegalpes.gitExamples and article case studies :Please have a look to examples :https://omegalpes-examples.readthedocs.io/en/latest/The OMEGAlpes Examples folder is available at:https://gricad-gitlab.univ-grenoble-alpes.fr/omegalpes/omegalpes-examples.gitSome examples and article case studies are avalaible as Notebooks at:https://gricad-gitlab.univ-grenoble-alpes.fr/omegalpes/omegalpes_notebooks.gitA scientific article presenting OMEGAlpes with a detailed example is available here:https://hal.archives-ouvertes.fr/hal-02285954v1Notebooks :Mostly all examples and article case studies are associated to a Notebook.
They can be found in the folder notebooks at :https://gricad-gitlab.univ-grenoble-alpes.fr/omegalpes/omegalpes_examplesOMEGAlpes-web interface :An web interface is available athttps://mhi-srv.g2elab.grenoble-inp.fr/OMEGAlpes-web-front-end/This interface enable you to generate scripts more easily using the graphical representation detailed
inhttps://omegalpes.readthedocs.io/en/latest/OMEGAlpes_grah_representation.htmlOMEGAlpes' CommunityPlease subscribe to our mailing lists :for our newsletters:https://groupes.renater.fr/sympa/subscribe/omegalpes-newsas an OMEGAlpes' developer:https://groupes.renater.fr/sympa/subscribe/omegalpes-usersPlease use the git issues system to report an error:https://gricad-gitlab.univ-grenoble-alpes.fr/omegalpes/omegalpes.gitOtherwise you can also contact de developer team using the following email adress:omegalpes-users@groupes.renater.frInstallation HelpYou can install the library as a user or as a developer. Please follow the corresponding installation steps below.You can use any development environment
If you use Pycharm, some indications below will help you for the installationhttps://www.jetbrains.com/pycharm/PrerequisitePlease install Python 3.6https://www.python.org/downloads/Installation as a userPlease install OMEGAlpes Lib with pip using the command prompt.If you are admin on Windows or working on a virtual environmentpip install omegalpesIf you want a local installation or you are not adminpip install --user omegalpesIf you are admin on Linux:sudo pip install omegalpesThen, you can download (or clone) the OMEGAlpes Examples folder (repository) at :https://gricad-gitlab.univ-grenoble-alpes.fr/omegalpes/omegalpes-examplesLaunch the examples (with Pycharm for instance) to understand how the OMEGAlpes Lib works.
Remember that the examples are detailed at :https://omegalpes-examples.readthedocs.io/en/latest/Enjoy your time using OMEGAlpes !Installation as a developer and local branch creationCreate a new folder in the suitable path, name it as you wish for example : OMEGAlpesClone the OMEGAlpes library repositoryCommand lover:git clone https://gricad-gitlab.univ-grenoble-alpes.fr/omegalpes/omegalpes.gitPycharm lover:Open PycharmOn the Pycharm window, click on "Check out from version control" then choose "Git".A "clone repository" window open.Copy the following link into the URL corresponding area:https://gricad-gitlab.univ-grenoble-alpes.fr/omegalpes/omegalpes.gitCopy the path of the new folder created just before.Test if the connection to the git works and if it works click on "Clone".Once OMEGAlpes is cloned, you must be able to see the full OMEGAlpes library on Pycharm
or on another development environment.If the connection does not work and if you are working with local protected network,
please try again with the wifi.First, choose or change your project interpreterPycharm lover:Click on the yellow warning link or go to "File", "settings...", "Project Interpreter"You can:either select the "Python 3.6" project interpreter but you may change the version
of some library that you could use for another applicationeither create a virtual environment in order to avoid this problem (recommended).Click on the star wheel near the project interpreter box.  Click on "add...".Select "New environment" if it not selected.The location is pre-filled, if not fill it with the path of the folder as folder_path/venvSelect "Python 3.6" as your base interpreterThen click on "Ok"You can install the library on developing mode using the following command in command prompt
once your are located it on the former folder.
If you are calling OMEGAlpes library in another project, the following command enables you to
refer to the OMEGAlpes library you are developingpython setup.py developIf it is not already done, install the library requirements.Command lover:pip install <library_name>If required, the command to upgrade the library is :pip install --upgrade <library_name>Pycharm lover:You should still have a yellow warning.You can:install automatically the libraries clicking on the yellow barinstall automatically the library using pip with Pycharm on "File", "settings...", "Project Interpreter", "+",
and choosing the required library as indicated in the Library Installation Requirements
partFinally, you can create your own local development branch.Command lover:git branch <branch_name>Pycharm lover:By default you are on a local branch named master.Click on "Git: master" located on the bottom write of PycharmSelect "+ New Branch"Name the branch as you convenience for instance "dev_your_name"Do not forget to "rebase" regularly to update your version of the library.Command lover:git rebase originPycharm lover:To do so, click on "VCS", "Git", "Fetch"
Then, click on your branch name on the bottom write of the Pycharm window
select "Origin/master" and click on "Rebase current onto selected"For contribution, have a look to CONTRIBUTING.md
Once your code is ready for contribution, do a last rebase (see 7.) and then,
request for a merge with the master branch in OMEGAlpes gitlabhttps://gricad-gitlab.univ-grenoble-alpes.fr/omegalpes/omegalpes.gitIf you want to have access to other examples and study cases,
please have a look to the user's installation.Enjoy your time developing OMEGAlpes!Library Installation RequirementsPuLP > 2.1Matplotlib > 2.2.2Numpy > 1.14.2Pandas > 0.25.0lpfics >= 0.0.1Partners:OMEGAlpes is mainly developped in the Grenoble Electrical Engineering
Laboratory (University Grenoble Alpes, CNRS, Grenoble INP, G2Elab, F-38000 Grenoble, France).
Other teams took part in the tool development:LOCIE (Laboratoire Optimisation de la Conception et IngÃ©nierie de lâ€™Environnement (LOCIE), CNRS UMR
5271â€”UniversitÃ© Savoie Mont Blanc, Polytech Annecy-ChambÃ©ry, Campus Scientifique, Savoie Technolac,
CEDEX, 73376 Le Bourget-Du-Lac,) in thermal engineering for the exergy package in particular  - in collaboration with Jaume Fito, Julien Ramousse and Benoit StutzPACTE (UniversitÃ© Grenoble-Alpes, UMR 5194 PACTE) in social sciences for
the actors package in particular  - in collaboration with Gilles DebizetMIAGE (Master MÃ©thodes informatiques appliquÃ©es Ã  la gestion des entreprises, UniversitÃ© Grenoble-Alpes) master students in computing for the GUI development.Acknowledgments:This work has been partially supported by:the CDP Eco-SESA receiving fund from the French National Research Agency in the framework of the "Investissements dâ€™avenir" program (ANR-15-IDEX-02)the OREBE fund from Auvergne RhÃ´ne-Alpesthe RETHINE fund from the French Agency for ecological transition (ADEME)LicenceThis code is under the Apache License, Version 2.0NotesThis library has been tested usingPyCharm 2018.2.4Python 3.6.0pip 18.1setuptools 39.1.0