Metadata-Version: 2.1
Name: FINE
Version: 2.2.2
Summary: Framework for integrated energy systems assessment
Home-page: https://github.com/FZJ-IEK3-VSA/FINE
Author: FINE Developer Team
Author-email: t.gross@fz-juelich.de
License: UNKNOWN
Description: [![Build Status](https://travis-ci.com/FZJ-IEK3-VSA/FINE.svg?branch=master)](https://travis-ci.com/FZJ-IEK3-VSA/FINE) [![Version](https://img.shields.io/pypi/v/FINE.svg)](https://pypi.python.org/pypi/FINE) [![Documentation Status](https://readthedocs.org/projects/vsa-fine/badge/?version=latest)](https://vsa-fine.readthedocs.io/en/latest/) [![PyPI - License](https://img.shields.io/pypi/l/FINE)]((https://github.com/FZJ-IEK3-VSA/FINE/blob/master/LICENSE.txt)) [![codecov](https://codecov.io/gh/FZJ-IEK3-VSA/FINE/branch/master/graph/badge.svg)](https://codecov.io/gh/FZJ-IEK3-VSA/FINE)
        
        
        <a href="https://www.fz-juelich.de/iek/iek-3/DE/Home/home_node.html"><img src="http://www.fz-juelich.de/SharedDocs/Bilder/IBG/IBG-3/DE/Plant-soil-atmosphere%20exchange%20processes/INPLAMINT%20(BONARES)/Bild3.jpg?__blob=poster" alt="Forschungszentrum Juelich Logo" width="230px"></a> 
        
        # FINE - Framework for Integrated Energy System Assessment
        
        The FINE python package provides a framework for modeling, optimizing and assessing energy systems. With the provided framework, systems with multiple regions, commodities and time steps can be modeled. Target of the optimization is the minimization of the total annual cost while considering technical and enviromental constraints. Besides using the full temporal resolution, an interconnected typical period storage formulation can be applied, that reduces the complexity and computational time of the model.
        
        If you want to use FINE in a published work, please [**kindly cite following publication**](https://www.sciencedirect.com/science/article/pii/S036054421830879X) which gives a description of the first stages of the framework. The python package which provides the time series aggregation module and its corresponding literatur can be found [**here**](https://github.com/FZJ-IEK3-VSA/tsam).
        
        ## Features
        * representation of an energy system by multiple locations, commodities and time steps
        * complexity reducing storage formulation based on typical periods
        
        ## Documentation
        
        A "Read the Docs" documentation of FINE can be found [**here**](https://vsa-fine.readthedocs.io/en/latest/).
        ## Requirements
        ### Framework
        The FINE Framework itself requires the following components:
        - FINE sourcecode
        - Python dependencies
        - A Mixed Integer Linear Programming (MILP) solver like Gurobi or GLPK
        ### Installation 
        The installation proceedure requires:
        - Git
        - Anaconda
        ## Installation of framework and dependencies
        ### Installation requirements
        1.  Install anaconda [by choosing your operating system here](https://docs.anaconda.com/anaconda/install/). If you are a Windows 10 user, remember to tick "Add Anaconda to my PATH environment variable" during installation under "Advanced installations options".
        2. Install git from https://git-scm.com/downloads
        ### Prepare folder
        1. Open a prompt e.g. "anaconda prompt" or "cmd" from the windows start menu
        2. Make a folder where you want to work, for example C:\Users\<your username>\work with "mkdir C:\Users\<your username>\work"
        3. Go to that directory with "cd C:\Users\<your username>\work" at the command line
        
        
        ### Get source code via GIT
        
        Clone public repository or repository of your choice first
        ```
        git clone https://github.com/FZJ-IEK3-VSA/FINE.git 
        ```
        Move into the FINE folder with
        ```
        cd fine
        ```
        
        ### Installation for users
        It is recommended to create a clean environment with conda to use FINE because it requires many dependencies. 
        
        ```
        conda env create -f requirements.yml
        ```
        
        This directly installs FINE and its dependencies in the `FINE` conda environment. Activate the created environment with:
        
        ```
        activate FINE
        ```
        
        ### Installation for developers
        Create a development environment if you want to modify it.
        Install the requirements in a clean conda environment:
        ```
        conda env create -f requirements_dev.yml
        activate FINE_dev
        ```
        
        This installs FINE and its requirements for development (testing, formatting). Further changes in the current folder are reflected in package installation through the installation with `pip -e`.
        
        Run the test suite with:
        ```
        pytest --cov=FINE test/
        ```
        
        ## Installation of an optimization solver
        
        FINE requires an MILP solver which can be accessed using [PYOMO](https://pyomo.readthedocs.io/en/stable/index.html). There are three standard solvers defined:
        - [GUROBI](http://www.gurobi.com/)
           - Recommended due to better performance but requires license (free academic version available)
           - Set as standard solver
        - [GLPK](https://sourceforge.net/projects/winglpk/files/latest/download)
          - Free version available 
        - [CBC](https://projects.coin-or.org/Cbc)
          - Free version available
        
        ### Gurobi installation
        The installation requires the following three components:
        - Gurobi Optimizer
            - In order to [download](https://www.gurobi.com/downloads/gurobi-optimizer-eula/) the software you need to create an account and obtain a license.
        - Gurobi license
            - The license needs to be installed according to the instructions in the registration process.
        - Gurobi python api
            - The python api can be installed according to [this instruction](https://support.gurobi.com/hc/en-us/articles/360044290292-How-do-I-install-Gurobi-for-Python-).
        
        ### GLPK installation
        A complete installation instruction for Windows can be found [here](http://winglpk.sourceforge.net/).
        
        ### CBC
        Installation procedure can be found [here](https://projects.coin-or.org/Cbc).
        
        ## Examples
        
        A number of [**examples**](examples/) shows the capabilities of FINE.
        
        ## License
        
        MIT License
        
        Copyright (C) 2016-2022 FZJ-IEK-3
        
        Active Developers: Theresa GroÃŸ, Leander Kotzur, Noah Pflugradt, Julian Belina, Toni Busch, Philipp Dunkel, Patrick Freitag, Thomas Grube, Heidi Heinrichs, Maximilian Hoffmann, Kevin Knosala, Felix Kullmann, Stefan Kraus, Jochen LinÃŸen, Rachel Maier, Peter Markewitz, Lars Nolting, Shruthi Patil, Jan Priesmann, Stanley Risch, Julian SchÃ¶nau, Bismark Singh, Andreas Smolenko, Peter Stenzel, Chloi Syranidou, Christoph Winkler, Michael Zier, Detlef Stolten
        
        Alumni: Robin Beer, Henrik BÃ¼sing, Dilara Caglayan, Timo KannengieÃŸer, Martin Robinius, Johannes ThÃ¼rauf, Lara Welder
        
        You should have received a copy of the MIT License along with this program.
        If not, see https://opensource.org/licenses/MIT
        
        
        ## About Us 
        <a href="https://www.fz-juelich.de/iek/iek-3/DE/Home/home_node.html"><img src="https://www.fz-juelich.de/SharedDocs/Bilder/IEK/IEK-3/Abteilungen2015/VSA_DepartmentPicture_2019-02-04_459x244_2480x1317.jpg?__blob=normal" alt="Institut TSA"></a> 
        
        We are the [Institute of Energy and Climate Research - Techno-economic Systems Analysis (IEK-3)](https://www.fz-juelich.de/iek/iek-3/DE/Home/home_node.html) belonging to the [Forschungszentrum JÃ¼lich](www.fz-juelich.de/). Our interdisciplinary institute's research is focusing on energy-related process and systems analyses. Data searches and system simulations are used to determine energy and mass balances, as well as to evaluate performance, emissions and costs of energy systems. The results are used for performing comparative assessment studies between the various systems. Our current priorities include the development of energy strategies, in accordance with the German Federal Governmentâ€™s greenhouse gas reduction targets, by designing new infrastructures for sustainable and secure energy supply chains and by conducting cost analysis studies for integrating new technologies into future energy market frameworks.
        
        ## Contributions and Users
        
        Within the BMWi funded project [**METIS**](http://www.metis-platform.net/) we develop together with the RWTH-Aachen ([**Prof. Aaron Praktiknjo**](http://www.wiwi.rwth-aachen.de/cms/Wirtschaftswissenschaften/Die-Fakultaet/Institute-und-Lehrstuehle/Professoren/~jgfr/Praktiknjo-Aaron/?allou=1&lidx=1)), the EDOM Team at FAU ([**PD Bismark Singh**](https://www.math.fau.de/wirtschaftsmathematik/team/bismark-singh/)) and the [**JÃ¼lich Supercomputing Centre**](http://www.fz-juelich.de/ias/jsc/DE/Home/home_node.html) new methods and models within FINE.
        
        <a href="http://www.metis-platform.net/"><img src="http://www.metis-platform.net/metis-platform/DE/_Documents/Pictures/projectTeamAtKickOffMeeting_640x338.jpg?__blob=normal" alt="METIS Team" width="400px" style="float:center"></a> 
        
        <p float="left">
        <a href="https://www.rwth-aachen.de/go/id/a/"> <img src="https://jugit.fz-juelich.de/iek-3/shared-code/fine/uploads/633d3c56d4fde45de2691c0262f96697/RWTH_Logo.png" width="230" /> </a> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
        <a href="https://www.fau.de/"> <img src="https://upload.wikimedia.org/wikipedia/commons/thumb/7/70/Friedrich-Alexander-Universit%C3%A4t_Erlangen-N%C3%BCrnberg_logo.svg/2000px-Friedrich-Alexander-Universit%C3%A4t_Erlangen-N%C3%BCrnberg_logo.svg.png" width="230" /> </a>
        </p>
        
        ## Acknowledgement
        
        This work was supported by the Helmholtz Association under the Joint Initiative ["Energy System 2050   A Contribution of the Research Field Energy"](https://www.helmholtz.de/en/research/energy/energy_system_2050/).
        
        <a href="https://www.helmholtz.de/en/"><img src="https://www.helmholtz.de/fileadmin/user_upload/05_aktuelles/Marke_Design/logos/HG_LOGO_S_ENG_RGB.jpg" alt="Helmholtz Logo" width="200px" style="float:right"></a>
        
Keywords: energy system,optimization
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
