Added docs

feos-org · g-bauer · Apr 18, 2024 · Feb 12, 2024 · Feb 15, 2024 · Feb 16, 2024
commit b8be814f047f4b392ebbf5c65814a707a2bba577
diff --git a/docs/api/eos.md b/docs/api/eos.md
@@ -21,6 +21,7 @@ If you want to adjust parameters of a model to experimental data you can use cla
     EquationOfState.python_residual
     EquationOfState.python_ideal_gas
     EquationOfState.uvtheory
+    EquationOfState.saftvrmie
     EquationOfState.saftvrqmie
 ```
 
@@ -54,7 +55,7 @@ If you want to adjust parameters of a model to experimental data you can use cla
 
 ## The `estimator` module
 
-### Import 
+### Import
 
 ```python
 from feos.eos.estimator import Estimator, DataSet, Loss, Phase

diff --git a/docs/api/index.md b/docs/api/index.md
@@ -24,7 +24,8 @@ These modules contain the objects to e.g. read parameters from files or build pa
    peng_robinson
    pets
    uvtheory
+   saftvrmie
    saftvrqmie
    joback
    dippr
-```
+```
diff --git a/docs/api/saftvrmie.md b/docs/api/saftvrmie.md
@@ -0,0 +1,28 @@
+# `feos.saftvrmie`
+
+Utilities to build `SaftVRMieParameters`.
+
+## Example
+
+```python
+from feos.saftvrmie import SaftVRMieParameters
+
+path = 'parameters/saftvrmie/lafitte2013.json'
+parameters = SaftVRMieParameters.from_json(['ethane', 'methane'], path)
+```
+
+## Data types
+
+```{eval-rst}
+.. currentmodule:: feos.saftvrmie
+
+.. autosummary::
+    :toctree: generated/
+
+    Identifier
+    ChemicalRecord
+    PureRecord
+    BinaryRecord
+    SaftVRMieRecord
+    SaftVRMieParameters
+```