mirror of
https://github.com/CoolProp/CoolProp.git
synced 2026-01-10 14:38:11 -05:00
Cleaned up a lot of warnings from sphinx build
Signed-off-by: Ian Bell <ian.h.bell@gmail.com>
This commit is contained in:
Ian Bell
@@ -1,60 +0,0 @@
|
||||
CoolProp Fluid Information
|
||||
==========================
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Fluids/pseudo_pure_fluids.rst
|
||||
Fluids/pure_fluids.rst
|
||||
|
||||
There are 4 basic classes of fluids that can be used in CoolProp, an example is provided for each one.
|
||||
|
||||
Pure Fluids, Pseudo-Pure Fluids
|
||||
-------------------------------
|
||||
All the fluids listed in Pure-Fluids and Pseudo-Pure-Fluids sections above can be used. To use one of these fluids, do something like
|
||||
|
||||
.. ipython::
|
||||
|
||||
In [1]: from CoolProp.CoolProp import PropsSI
|
||||
|
||||
#Density of dry air at 1 atm. and 25C
|
||||
In [1]: PropsSI('D','T',298,'P',101325,'Air')
|
||||
|
||||
You can also use any of the aliases of the fluids that are the listed on the fluid page. For instance, R717 is the refrigerant number for ammonia
|
||||
|
||||
.. ipython::
|
||||
|
||||
In [1]: from CoolProp.CoolProp import PropsSI
|
||||
|
||||
#Density of saturated ammonia vapor at 1 atm.
|
||||
In [1]: PropsSI('D','Q',1,'P',101325,'R717')
|
||||
|
||||
#Density of saturated ammonia vapor at 1 atm.
|
||||
In [1]: PropsSI('D','Q',1,'P',101325,'Ammonia')
|
||||
|
||||
|
||||
REFPROP Fluids and Mixtures
|
||||
---------------------------
|
||||
If you are on Windows and have REFPROP installed, you can use it with CoolProp. REFPROP needs to be installed in c:\\Program Files\\REFPROP. If it is somewhere else, just copy it to this location.
|
||||
|
||||
It is also possible to use REFPROP on Linux. Please follow the instructions from https://github.com/jowr/librefprop.so to install the library from Fortran sources. Additionally, you also need to copy the fluid and mixture files to /opt/refprop.
|
||||
|
||||
All the pure fluids in REFPROP are used just like the CoolProp fluids except that "REFPROP-" is added at the beginning of the fluid name. You can use any fluid that is included in REFPROP, but you must use the REFPROP fluid file name. For CoolProp Fluids, you can use the ``get_REFPROPName()`` function to get the REFPROP name for the fluid.
|
||||
|
||||
.. ipython::
|
||||
|
||||
In [1]: from CoolProp.CoolProp import PropsSI
|
||||
|
||||
#Saturated isobutane vapor density at 1 atmosphere
|
||||
In [1]: PropsSI('D','Q',1,'P',101.325,'REFPROP::ISOBUTAN')
|
||||
|
||||
You can also use mixtures in REFPROP, there is a special format for the fluid name. The fluid name is set up like this: ``"REFPROP::R32[0.697615]&R125[0.302385]"`` - this is R410A. The numbers within the brackets are the mole fractions of the components. They must add up to 1.0
|
||||
|
||||
.. ipython::
|
||||
|
||||
In [1]: from CoolProp.CoolProp import PropsSI
|
||||
|
||||
#Saturated R410 vapor density at 1 atmosphere using the mixture properties
|
||||
In [1]: PropsSI('D','Q',1,'P',101.325,'REFPROP::R32[0.697615]&R125[0.302385]')
|
||||
|
||||
In Engineering Equation Solver (EES), you can compose a fluid string using something like ``a$='REFPROP::'||'R32'||'['||yy$||']'||and$||'R125'||'['||xx$||']'`` where ``yy`` and ``xx`` are mole fractions of R32 and R125 respectively.
|
||||
|
||||
@@ -1,7 +0,0 @@
|
||||
CoolProp.BibtexParser module
|
||||
============================
|
||||
|
||||
.. automodule:: CoolProp.BibtexParser
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -1,7 +0,0 @@
|
||||
CoolProp.CoolProp module
|
||||
========================
|
||||
|
||||
.. automodule:: CoolProp.CoolProp
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -1,7 +0,0 @@
|
||||
CoolProp.GUI.CoolPropGUI module
|
||||
===============================
|
||||
|
||||
.. automodule:: CoolProp.GUI.CoolPropGUI
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -1,7 +0,0 @@
|
||||
CoolProp.GUI.PsychScript module
|
||||
===============================
|
||||
|
||||
.. automodule:: CoolProp.GUI.PsychScript
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -1,18 +0,0 @@
|
||||
CoolProp.GUI package
|
||||
====================
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
CoolProp.GUI.CoolPropGUI
|
||||
CoolProp.GUI.PsychScript
|
||||
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: CoolProp.GUI
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -1,7 +0,0 @@
|
||||
CoolProp.HumidAirProp module
|
||||
============================
|
||||
|
||||
.. automodule:: CoolProp.HumidAirProp
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -1,7 +0,0 @@
|
||||
CoolProp.Plots.Common module
|
||||
============================
|
||||
|
||||
.. automodule:: CoolProp.Plots.Common
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -1,7 +0,0 @@
|
||||
CoolProp.Plots.Plots module
|
||||
===========================
|
||||
|
||||
.. automodule:: CoolProp.Plots.Plots
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -1,7 +0,0 @@
|
||||
CoolProp.Plots.PsychChart module
|
||||
================================
|
||||
|
||||
.. automodule:: CoolProp.Plots.PsychChart
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -1,7 +0,0 @@
|
||||
CoolProp.Plots.PsychScript module
|
||||
=================================
|
||||
|
||||
.. automodule:: CoolProp.Plots.PsychScript
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -1,7 +0,0 @@
|
||||
CoolProp.Plots.SimpleCycles module
|
||||
==================================
|
||||
|
||||
.. automodule:: CoolProp.Plots.SimpleCycles
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -1,7 +0,0 @@
|
||||
CoolProp.Plots.Tests module
|
||||
===========================
|
||||
|
||||
.. automodule:: CoolProp.Plots.Tests
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -1,22 +0,0 @@
|
||||
CoolProp.Plots package
|
||||
======================
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
CoolProp.Plots.Common
|
||||
CoolProp.Plots.Plots
|
||||
CoolProp.Plots.PsychChart
|
||||
CoolProp.Plots.PsychScript
|
||||
CoolProp.Plots.SimpleCycles
|
||||
CoolProp.Plots.Tests
|
||||
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: CoolProp.Plots
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -1,7 +0,0 @@
|
||||
CoolProp.State module
|
||||
=====================
|
||||
|
||||
.. automodule:: CoolProp.State
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -1,7 +0,0 @@
|
||||
CoolProp.constants module
|
||||
=========================
|
||||
|
||||
.. automodule:: CoolProp.constants
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -1,32 +0,0 @@
|
||||
CoolProp package
|
||||
================
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
CoolProp.GUI
|
||||
CoolProp.Plots
|
||||
CoolProp.tests
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
CoolProp.BibtexParser
|
||||
CoolProp.CoolProp
|
||||
CoolProp.CoolProp
|
||||
CoolProp.HumidAirProp
|
||||
CoolProp.State
|
||||
CoolProp.constants
|
||||
CoolProp.constants
|
||||
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: CoolProp
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -1,27 +0,0 @@
|
||||
CoolProp.tests package
|
||||
======================
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
CoolProp.tests.runner
|
||||
CoolProp.tests.test_CoolPropState
|
||||
CoolProp.tests.test_HAProps
|
||||
CoolProp.tests.test_Props
|
||||
CoolProp.tests.test_Props1
|
||||
CoolProp.tests.test_Saturation
|
||||
CoolProp.tests.test_State
|
||||
CoolProp.tests.test_Units_CPState
|
||||
CoolProp.tests.test_consistency
|
||||
CoolProp.tests.test_param_getters
|
||||
CoolProp.tests.test_plots
|
||||
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: CoolProp.tests
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -1,7 +0,0 @@
|
||||
CoolProp.tests.runner module
|
||||
============================
|
||||
|
||||
.. automodule:: CoolProp.tests.runner
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -1,7 +0,0 @@
|
||||
CoolProp.tests.test_CoolPropState module
|
||||
========================================
|
||||
|
||||
.. automodule:: CoolProp.tests.test_CoolPropState
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -1,7 +0,0 @@
|
||||
CoolProp.tests.test_HAProps module
|
||||
==================================
|
||||
|
||||
.. automodule:: CoolProp.tests.test_HAProps
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -1,7 +0,0 @@
|
||||
CoolProp.tests.test_Props module
|
||||
================================
|
||||
|
||||
.. automodule:: CoolProp.tests.test_Props
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -1,7 +0,0 @@
|
||||
CoolProp.tests.test_Props1 module
|
||||
=================================
|
||||
|
||||
.. automodule:: CoolProp.tests.test_Props1
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -1,7 +0,0 @@
|
||||
CoolProp.tests.test_Saturation module
|
||||
=====================================
|
||||
|
||||
.. automodule:: CoolProp.tests.test_Saturation
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -1,7 +0,0 @@
|
||||
CoolProp.tests.test_State module
|
||||
================================
|
||||
|
||||
.. automodule:: CoolProp.tests.test_State
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -1,7 +0,0 @@
|
||||
CoolProp.tests.test_Units_CPState module
|
||||
========================================
|
||||
|
||||
.. automodule:: CoolProp.tests.test_Units_CPState
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -1,7 +0,0 @@
|
||||
CoolProp.tests.test_consistency module
|
||||
======================================
|
||||
|
||||
.. automodule:: CoolProp.tests.test_consistency
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -1,7 +0,0 @@
|
||||
CoolProp.tests.test_param_getters module
|
||||
========================================
|
||||
|
||||
.. automodule:: CoolProp.tests.test_param_getters
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -1,7 +0,0 @@
|
||||
CoolProp.tests.test_plots module
|
||||
================================
|
||||
|
||||
.. automodule:: CoolProp.tests.test_plots
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -114,4 +114,4 @@ References
|
||||
:style: unsrt
|
||||
|
||||
|
||||
.. include:: fluidstoc.rst
|
||||
.. include:: fluidstoc.rst.in
|
||||
|
||||
@@ -6,7 +6,7 @@ import CoolProp
|
||||
web_dir = os.path.abspath(os.path.join(os.path.dirname(__file__),'..'))
|
||||
root_dir = os.path.abspath(os.path.join(web_dir, '..'))
|
||||
csvfile = os.path.join(web_dir,'fluid_properties','PurePseudoPure.csv')
|
||||
indexfile = os.path.join(web_dir,'fluid_properties', 'fluidstoc.rst')
|
||||
indexfile = os.path.join(web_dir,'fluid_properties', 'fluidstoc.rst.in')
|
||||
|
||||
class Dossier:
|
||||
def __init__(self):
|
||||
|
||||
Reference in New Issue
Block a user