Metadata-Version: 2.1
Name: TESPy
Version: 0.4.3.post5
Summary: Thermal Engineering Systems in Python (TESPy)
Home-page: https://github.com/oemof/tespy
Author: Francesco Witte
Author-email: francesco.witte@hs-flensburg.de
License: MIT
Project-URL: Issue Tracker, https://github.com/oemof/tespy/issues
Project-URL: Documentation, https://tespy.readthedocs.io/
Project-URL: Changelog, https://tespy.readthedocs.io/en/latest/whats_new.html
Description: Thermal Engineering Systems in Python
        =====================================
        
        TESPy stands for "Thermal Engineering Systems in Python" and provides a
        powerful simulation toolkit for thermal engineering plants such as power
        plants, district heating systems or heat pumps. It is an external extension
        module within the `Open Energy Modelling Framework <https://oemof.org/>`_ and
        can be used as a standalone package.
        
        .. figure:: https://raw.githubusercontent.com/oemof/tespy/9915f013c40fe418947a6e4c1fd0cd0eba45893c/docs/api/_images/logo_tespy_big.svg
            :align: center
        
        With the TESPy package you are able to calculate stationary operation in order
        to design the process of thermal energy systems. From that point it is possible
        to simulate the offdesign behavior of your plant using underlying
        characteristics for each of the plants components. The package includes basic
        components, such as turbines, pumps, compressors, heat exchangers, pipes,
        mixers and splitters as well as some advanced components (derivatives of heat
        exchangers, drum).
        
        Everybody is welcome to use and/or develop TESPy. Contribution is already
        possible on a low level by simply fixing typos in TESPy's documentation or
        rephrasing sections which are unclear. If you want to support us that way
        please fork the TESPy repository to your own github account and make changes
        as described in the github guidelines:
        https://guides.github.com/activities/hello-world/
        
        Key Features
        ============
        * **Open** Source
        * **Generic** thermal engineering applications
        * **Automatic** model documentation in LaTeX for high transparency and
          reproducibility
        * **Extendable** framework for the implementation of custom components and
          component groups
        * **Postprocessing** features like exergy analysis and fluid property plotting
        
        
        
        Documentation
        =============
        
        You can find the full documentation at
        `readthedocs <http://tespy.readthedocs.org>`_. Use the
        `project site <http://readthedocs.org/projects/tespy>`_ of readthedocs to
        choose the version of the documentation. Go to the
        `download page <http://readthedocs.org/projects/tespy/downloads/>`_ to
        download different versions and formats (pdf, html, epub) of the documentation.
        
        To get the latest news visit and follow our `website <https://www.oemof.org>`_.
        
        Installing TESPy
        ================
        
        If you have a working Python3 environment, use pypi to install the latest
        tespy version:
        
        .. code:: bash
        
          pip install tespy
        
        If you want to use the latest features, you might want to install the
        **developer version**. See section
        `Developing TESPy <http://tespy.readthedocs.io/en/dev/developing_tespy.html>`_
        for more information. The developer version is not recommended for productive
        use.
        
        Examples
        ========
        
        For a short introduction on how TESPy works and how you can use it, we provide
        some
        `examples and tutorials <https://tespy.readthedocs.io/en/main/tutorials_examples.html>`_,
        go and check them out. You can download the python scripts of all example plants
        from the
        `tespy_examples <https://github.com/oemof/oemof-examples/tree/master/oemof_examples/tespy>`_
        repository.
        
        Citation
        ========
        
        The scope and functionalities of TESPy have been documented in a paper
        published in the Journal of Open Source Software with an OpenAccess license.
        Download the paper from https://doi.org/10.21105/joss.02178. As TESPy is a free
        software, we kindly ask that you add a reference to TESPy if you use the
        software for your scientific work. Please cite the article with the BibTeX
        citation below.
        
        Additionally, you have the possibility to cite a specific version of TESPy to
        make your work reproducible. The source code of every version is published on
        zenodo. Find your version here: https://doi.org/10.5281/zenodo.2555866.
        
        BibTeX citation::
        
            @article{Witte2020,
                doi = {10.21105/joss.02178},
                year = {2020},
                publisher = {The Open Journal},
                volume = {5},
                number = {49},
                pages = {2178},
                author = {Francesco Witte and Ilja Tuschy},
                title = {{TESPy}: {T}hermal {E}ngineering {S}ystems in {P}ython},
                journal = {Journal of Open Source Software}
            }
        
        License
        =======
        
        Copyright (c) 2017-2021 oemof developer group
        
        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.
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.7, <3.9
Provides-Extra: dummy
Provides-Extra: dev
