Updated Readme

README.md

@@ -5,7 +5,7 @@ RGP Table Generator v.0
 - Support for CoolProp and REFPROP backends
 - Able to crate a liquid-like metastable region 
 - Capable of replacing saturation curve with spinodal line
-- Sucessfully tested for CO2
+- Sucessfully tested for Air,too
 
 Dependencies
 ------------
@@ -15,12 +15,6 @@ Dependencies
 - pandas==1.4.0
 - scipy==1.7.3
 
-Issues
-------
-
-- Metaestability for mixtures only works with REFPROP backend (should pass the reprop library path)
-- Metaestability require large number os discrete points for pressure and temperature.
-- HEOS backend(CoolProp) unable to run for mixtures.
 
 
 Installation
@@ -29,61 +23,36 @@ Installation
 Clone this git repository
 
 ```console
-git clone https://github.com/properallan/RGPmeta.git
-```
-
-Recomended to create a and enviroment with Python 3.8
-
-```console
-conda create -n rgp python=3.8
+git clone https://github.com/ShreySahai/RGPGenerator.git
 ```
-
-Activate the environemnt
-
-```console
-conda activate rgp
-```
-
 Move to root path of git repository
 
+Run RGP.py
+
 ```console
-cd RGPmeta
+python RGP.py -f Air -p 1e5,10e6 -T 150,1000 -np 20 -nT 20 -ns 20 -Tsat 80,82 -o air.rgp
 ```
 
-You are ready to go! (TO RUN USING REFPROP backend, the path to proprietary libraries is set using a command line option `-rp /home/ppiper/MEGA/refprop`)
-
-Sample command to generate a RGP table for CO2
-----------------------------------------------
-```python3 RGP.py -f CO2 -b HEOS -p 0.518e6,30e6 -T 230,520 -np 100 -nT 100 -ns 100 -mo 1 -sat True -me True -sp True -o out.rgp```
-
-`python3` should match the python 3 interpreter alias of your operational system
-
-Mixtures only working with `REFPROP` backend, in this case fluid name should be given as the AbstractState string standard, and mass fractions as a list `0,1`, example:
-
-```python3.8 RGP.py -f 'CO2&Methane' -mf 0.95,0.05 -b REFPROP -p 1e6,20e6 -T 250,500 -rp /home/ppiper/MEGA/refprop -nT 100 -np 100 -me True -op ./outputs/ -o CO2_50_50_COOLPROP.rgp```
+You are ready to go!
 
 
 Command Line Options
 --------------------
 ```
 optional arguments:
-  -h, --help            show this help message and exit
   -f , --fluid          CoolProp fluidname
-  -b , --backend        CoolProp backend e.g. (HEOS, REFPROP)
-  -rp , --refprop_path 
-                        REFPROP install path
   -p , --pressures      Pressure range for the RGP table
   -T , --temperatures   Temperature range for the RGP table
   -np , --n_pressures   Number of points to discretize pressure range
   -nT , --n_temperatures 
                         Number of points to discretize temperature range
+  -ns , --n_saturation 
+                        Number of points to discretize saturation table range
   -o , --output_file    Output file name
-  -me , --metastable    Turn metastable region on and off e.g. (True, False)
 ```
 
 
 References
 ----------
 
-https://link.springer.com/article/10.1134/S0036024406040030
-https://github.com/CoolProp/CoolProp/blob/master/doc/notebooks/Maxwell_Loop.ipynb
+https://github.com/properallan/RGPmeta