Metadata-Version: 2.1
Name: REFPROP-connector
Version: 0.3.9
Summary: Tools for launching REFPROP calculation and retrieving results from python
Home-page: https://www.dief.unifi.it/vp-177-serg-group-english-version.html
Author: Pietro Ungar
Author-email: pietro.ungar@unifi.it
License: GNU GPLv3
Download-URL: https://github.com/SERGGroup/REFPROPConnector/archive/refs/tags/0.3.9.tar.gz
Project-URL: Source, https://github.com/SERGGroup/REFPROPConnector
Project-URL: Tracker, https://github.com/SERGGroup/REFPROPConnector/issues
Description: # REFPROP connector
        
        __REFPROP connector__ is a tools developed by the [SERG research group](https://www.dief.unifi.it/vp-177-serg-group-english-version.html) 
        of the [University of Florence](https://www.unifi.it/changelang-eng.html) for launching [REFPROP](https://www.nist.gov/srd/refprop) 
        calculation and retrieving results from python. 
        
        In order to use the code you must have both REFPROP and the [REFPROP wrappers for Python](https://github.com/usnistgov/REFPROP-wrappers) 
        installed and properly working.
        
        The scope of this library is to make the usage of the refprop wrappers simpler.
        
        ### Download and installation 
        
        The beta version can be downloaded using __PIP__:
        
        ```
        pip install REFPROP_connector
        ```
        
        ### First Steps
        Once the installation has been completed the user can import the tool and initialize the connector itself.
        ```python
        from REFPROPConnector import ThermodynamicPoint
        
        tp = ThermodynamicPoint(["air"], [1.])
        
        ```
        __An important aspects to keep in mind for the initialization:__
        
          * A file-dialog __could__ appear the first time that the connector is imported __asking the user to select the REFPROP 
            installation folder__ (usually it's _"C:\Program Files (x86)\REFPROP"_). 
            Once the executable path has been selected, the program will keep it in memory in order to avoid a new appearance 
            of the file-dialog. The stored executable can be modified calling the following function:
            
        ```python
        from REFPROPConnector import retreive_RP_exec
        
        retreive_RP_exec()
        ```
            
        ### Basic Usage
        
        Each _ThermodynamicPoint_ class instance represent a thermodynamic state, hence you had to provide at least 
        __two indipendent state variables__ in order to calculate the others.
        
        
        ```python
        from REFPROPConnector import ThermodynamicPoint
        
        tp = ThermodynamicPoint(["water"], [1.])
        
        tp.set_variable("P", 0.101325)     # P in MPa (ambient pressure)
        tp.set_variable("Q", 0.5)          # vapour quality for multiphase condition
        
        T_sat = tp.get_variable("T")       # saturation temperature in celsius (100 °C)
        ```
        
        ### Abstract Class
        
        _AbstractThermodynamicPoint_ is a class that can be overwritten in order to perform some calculation once both 
        independent state variable have been set. It can be useful for example for the evaluation of the reynolds number 
        for a fluid flowing in a pipe.
        
        ```python
        from REFPROPConnector import AbstractThermodynamicPoint, RefPropHandler, init_handler
        import numpy as np
        
        
        class TubeSection(AbstractThermodynamicPoint):
        
            def __init__(self, diam, flow_rate):
                
                self.diam = diam
                self.area = np.pi * np.power(diam / 2, 2)
                self.flow_rate = flow_rate
                self.Re = 0.
                
                refprop = init_handler(
        
                    chosen_subclass=RefPropHandler,
                    fluids=["air"], composition=[1]
                    
                )
        
                super().__init__(refprop)
        
            def other_calculation(self):
                
                mu = self.get_variable("mu") / (10 ** 6)  # conversion uPa*s -> Pa*s
                self.Re = self.flow_rate * self.diam / (self.area * mu)
        
        if __name__ == "__main__":
        
            section = TubeSection(0.5, 1)
            
            """
            
                The following line will return 0. as the function "other_calculation" 
                is called only when 2 independent state variables are provided 
                
            """
            print(section.get_variable("Re"))   
            
            section.set_variable("P", 0.5)
            section.set_variable("T", 20)
            
            """
            
                The following line will return the actual Reynolds number
                
            """
            print(section.get_variable("Re"))
        ```
        
        ### Unit system and state variable list
        
        Variable that can be calculated can be listed using _list_properties_ method from both _ThermodynamicPoint_ and 
        _AbstractThermodynamicPoint_ (the name __is not case-sensitive__). Finally, user can also select the unit system to be 
        used in the calculation, a list of possible unit system can be revived calling the method _list_unit_systems()_ 
        (current unit_system will be highlighted):  
        
        ```python
        from REFPROPConnector import ThermodynamicPoint
        
        tp = ThermodynamicPoint(["water"], [1.], unit_system="MASS BASE SI")
        tp.list_properties()
        tp.list_unit_systems()
        ```
        Default unit system is __SI with C__
        
        ### Metastable Calculation
        
        You can force the state to represent a metastable condition as follows:  
        
        ```python
        from REFPROPConnector import ThermodynamicPoint
        
        tp = ThermodynamicPoint(["water"], [1.], unit_system="MASS BASE SI")
        tp.metastability = "liq" # or "vap" for vapour metastable condition
        ```
        Acceptable keywords for metastability are ["liquid", "liq", "l", ">"] for the liquid metastable state, 
        or ["vap", "vapour", "vapor", "v", "<"] for the vapour state (keywords **are not** case-sensitive).
        
        ### Diagram Plotter
        The _DiagramPlotter_ class can be used to plot a specific state diagram that can be then used to describe state 
        transformations. The diagram can be personalized using the _DiagramPlotterOptions_ class. 
        The following is an example on how to use the class.
        
        
        ```python
        from REFPROPConnector import (
            
            ThermodynamicPoint, 
            DiagramPlotter, 
            DiagramPlotterOptions
        
        )
        
        tp = ThermodynamicPoint(["Carbon Dioxide"], [1])
        options = DiagramPlotterOptions(
        
            x_variable="T",
            x_var_range = (0, 150), x_var_log=False,
            y_var_range = (4, 15),
            isoline_ranges={
        
                "rho": (50, 1000, 25),
                "H": (200, 550, 25)
        
            }
        
        )
        plotter = DiagramPlotter(tp, options=options)
        plotter.calculate()
        
        fig, (ax_1) = plt.subplots(1, 1, dpi=200)
        fig.set_size_inches(10, 5)
        plotter.plot(ax_1)
        plt.show()
        ```
        
        __-------------------------- !!! THIS IS A BETA VERSION !!! --------------------------__ 
        
        please report any bug or problems in the installation to _pietro.ungar@unifi.it_<br/>
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Description-Content-Type: text/markdown
