Metadata-Version: 2.1
Name: pytrnsys
Version: 0.5a7
Summary: pytrnsys simulation framework
Home-page: https://pytrnsys.readthedocs.io
Author: Dani Carbonell, Mattia Battaglia, Jeremias Schmidli, Martin Neugebauer
Author-email: martin.neugebauer@spf.ch
License: UNKNOWN
Description: 
        # pytrnsys: The python TRNSYS tool kit
         
        The pytrnsys package provides a complete framework to run and process, plot and report 
        TRNSYS simulations. It is designed to give researchers a fast,
        fully automatized and easily reproducible way to execute and share TRNSYS simulations by the use of a single short
        configuration file. In addition, a large variety of commands is accessible
        to post-process simulation results in one shot.
        
        ## Documentation
        
        The documentation can be found on [pytrnsys.readthedocs.io](https://pytrnsys.readthedocs.io).
        
        ## Installation
        
        In the following all commands should be run from the `pytrnsys` directory. The command should be run in a 
        "Windows Command Prompt" for Windows environment. The commands should be very similar should you wish to install on
        Linux.
        
        If you want to install pytrnsys as a python package, follow the "Binary installation / User installation". If you want 
        to develop the code, you will need git. Then you should follow the "Installation from source / Developer installation". 
        
        ### Binary installation / User installation
        
        #### Prerequisites
        
        ##### Required
        
        1. [Python 3.9](https://www.python.org/downloads/)
        
        #### Getting started
        
        1. Open a command prompt (e.g. by hitting the Windows-key, then typing "cmd" 
           into the search box and hitting enter). The following commands should be entered
           into the command prompt just opened.
        
        1. Navigate to the directory which should contain the `pytrnsys` directory:
            ```commandline
            cd [your-directory]
            ```
           Replace `[your-directory]` (including the brackets []) with your directory of choice: if your
        directory is called `foo` then `pytrnsys` will be installed to `foo\pytrnsys`.
           
        1. Create a virtual environment:
            ```commandline
            py -3.9 -m venv pytrnsys
            ```
        1. Activate it:
            ```commandline
            pytrnsys\Scripts\activate
            ```
        1. Install the `wheel` package:
            ```commandline
            pip install wheel
            ```
                 
        1. Install `pytrnsys` and its requirements:
            ```commandline
            pip install -r https://raw.githubusercontent.com/SPF-OST/pytrnsys/master/requirements/releases/v0.5a4/requirements.txt
            ```
        You can now close the command prompt opened in the first step.
        
        pytrnsys can now be used from a python editor of your choice within the virtual environment you created.
        
        
        ### Installation from source / Developer installation
        
        #### Prerequisites
        
        ##### Required
        
        1. [Python 3.9](https://www.python.org/downloads/)
        1. A local clone of the following GIT repository:
            `https://github.com/SPF-OST/pytrnsys.git`
        
        ##### Recommended
        * [PyCharm Community IDE](https://www.jetbrains.com/pycharm/download/)
        
        #### Getting started
        
        All the following commands should be run from the `pytrnsys` directory. The commands
        specified are for a Windows environment. They are very similar for Linux.
        
        1. Create a virtual environment:
            ```commandline
            py -3.9 -m venv venv
            ```
        1. Activate it:
            ```commandline
            venv\Scripts\activate
            ```
        1. Install the requirements:
            ```commandline
            pip install wheel
            pip install -r requirements\dev\requirements.txt
            ```
        
        And you're ready to go!
            
        Beware that `pytrnsys` can only be run from within the virtual environment you created in 
        step 1, i.e., whenever you open a new console window from which you want to run it you 
        first need to active the environment (step 2. above).
        
        
        ## About
        
        This code was not initially developed with the intention to be shared with others outside our institute SPF,
        but after realizing that it could help the community to have a better workflow with TRNSYS, we decided to share it.
        
        #### Developers: 
        - Daniel Carbonell : Institut für Solartechnik SPF, Rapperswil, Switzerland.
        - Jeremias Schmidli : Institut für Solartechnik SPF, Rapperswil, Switzerland.
        - Maike Schubert: Institut für Solartechnik SPF, Rapperswil, Switzerland.
        - Martin Neugebauer: Institut für Solartechnik SPF, Rapperswil, Switzerland.
        - Mattia Battaglia : Institut für Solartechnik SPF, Rapperswil, Switzerland.
        
        ## Acknowledgements
         
        A first version of this package was created in 2013 and since then it has evolved considerably. 
        We would like to thank the Swiss Federal Office Of Energy (SFOE) 
        who supported many projects related to simulations of renewable energy systems where this code has been developed. 
        We would also like to thank the European Union’s Horizon 2020 research and innovation programme
        for the funding received in TRI-HP under the Grant Agreement No. 81488. 
        This project allowed to decicate efforts in sharing the code with the consortium and to make the code usable for the others.  
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
Requires-Python: >=3.9
Description-Content-Type: text/markdown
