added Python documentation

feos-org · prehner · Apr 19, 2024 · Mar 5, 2024 · Mar 6, 2024 · Mar 6, 2024
commit 99b8664dfc5489b892ee1473b063bad6aa53eee9
diff --git a/docs/api/eos.md b/docs/api/eos.md
@@ -15,6 +15,7 @@ If you want to adjust parameters of a model to experimental data you can use cla
 
     EquationOfState
     EquationOfState.pcsaft
+    EquationOfState.epcsaft
     EquationOfState.gc_pcsaft
     EquationOfState.peng_robinson
     EquationOfState.pets

diff --git a/docs/api/epcsaft.md b/docs/api/epcsaft.md
@@ -0,0 +1,35 @@
+# `feos.epcsaft`
+
+Utilities to build `ElectrolytePcSaftParameters`.
+
+## Example
+
+```python
+from feos.epcsaft import ElectrolytePcSaftParameters
+
+path = 'parameters/epcsaft/held2014_w_permittivity_added.json'
+parameters = ElectrolytePcSaftParameters.from_json(['water', 'sodium ion', 'chloride ion'], path)
+```
+
+## Data types
+
+```{eval-rst}
+.. currentmodule:: feos.epcsaft
+
+.. autosummary::
+    :toctree: generated/
+
+    Identifier
+    IdentifierOption
+    ChemicalRecord
+    SmartsRecord
+    ElectrolytePcSaftVariants
+    ElectrolytePcSaftRecord
+    ElectrolytePcSaftBinaryRecord
+    PureRecord
+    SegmentRecord
+    BinaryRecord
+    BinarySegmentRecord   
+    ElectrolytePcSaftParameters
+    PermittivityRecord
+```
diff --git a/docs/api/index.md b/docs/api/index.md
@@ -20,6 +20,7 @@ These modules contain the objects to e.g. read parameters from files or build pa
    :maxdepth: 1
 
    pcsaft
+   epcsaft
    gc_pcsaft
    peng_robinson
    pets
-Original file line number
+Diff line change
@@ Expand Up @@
        :maxdepth: 1
        pcsaft
+       epcsaft
        gc_pcsaft
        peng_robinson
        pets
@@ Expand Down @@