diff --git a/docs/api/index.md b/docs/api/index.md index d02c12415..749d7d08c 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -6,7 +6,6 @@ .. toctree:: :maxdepth: 1 - si eos dft ``` diff --git a/docs/api/si.md b/docs/api/si.md deleted file mode 100644 index 01bce2b67..000000000 --- a/docs/api/si.md +++ /dev/null @@ -1,31 +0,0 @@ -# `feos.si` - -This module contains data types for dimensioned quantities, i.e. floating point values multiplied with units. -If you want to learn more about this module, take a look at [this notebook](/tutorials/utility/core_working_with_units). - -## Example usage - -```python -from feos.si import KELVIN, RGAS, METER, MOL, BAR - -p_ig = 25.0 * MOL / METER**3 * RGAS * 315.5 * KELVIN -print('Ideal gas pressure: {:.2f} bar'.format(p_ig / BAR)) -``` -``` -Ideal gas pressure: 0.66 bar -``` - -## Data types - -```{eval-rst} -.. currentmodule:: feos.si - -.. autosummary:: - :toctree: generated/ - - SINumber - SIArray1 - SIArray2 - SIArray3 - SIArray4 -``` \ No newline at end of file diff --git a/docs/tutorials/utility/core_working_with_units.ipynb b/docs/tutorials/utility/core_working_with_units.ipynb index 3e902d13e..c539be1b2 100644 --- a/docs/tutorials/utility/core_working_with_units.ipynb +++ b/docs/tutorials/utility/core_working_with_units.ipynb @@ -10,7 +10,7 @@ "\n", "> Learn how to work with `SINumber` and `SIArray` objects which represent physical quantities, i.e. one or more floating point numbers with an associated unit.\n", "\n", - "## The `feos.si` module\n", + "## The `si-units` module\n", "\n", "Most interfaces in `FeOs` use dimensioned quantities as input. For example, to define a thermodynamic state at given temperature, pressure and amount of substance, all of these properties have to be multiplied by an apropriate unit before we can call the function that creates the state.\n", "\n", diff --git a/examples/core_working_with_units.ipynb b/examples/core_working_with_units.ipynb index 3e902d13e..c539be1b2 100644 --- a/examples/core_working_with_units.ipynb +++ b/examples/core_working_with_units.ipynb @@ -10,7 +10,7 @@ "\n", "> Learn how to work with `SINumber` and `SIArray` objects which represent physical quantities, i.e. one or more floating point numbers with an associated unit.\n", "\n", - "## The `feos.si` module\n", + "## The `si-units` module\n", "\n", "Most interfaces in `FeOs` use dimensioned quantities as input. For example, to define a thermodynamic state at given temperature, pressure and amount of substance, all of these properties have to be multiplied by an apropriate unit before we can call the function that creates the state.\n", "\n", diff --git a/src/python/mod.rs b/src/python/mod.rs index d32101c9e..c60a2caf0 100644 --- a/src/python/mod.rs +++ b/src/python/mod.rs @@ -57,7 +57,6 @@ pub fn feos(m: &Bound<'_, PyModule>) -> PyResult<()> { #[cfg(feature = "saftvrmie")] m.add_wrapped(wrap_pymodule!(saftvrmie_module))?; - // set_path(m, "feos.si", "quantity")?; set_path(m, "feos.eos", "eos")?; #[cfg(feature = "estimator")] set_path(m, "feos.eos.estimator", "eos.estimator_eos")?;