Merge pull request #9 from HiDiHlabs/dev

Release 1

.github/workflows/publish-pypi.yml

@@ -0,0 +1,21 @@
+name: Publish Python Package to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write # to authenticate as Trusted Publisher to pypi.org
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+          cache: "pip"
+      - run: pip install build
+      - run: python -m build
+      - uses: pypa/gh-action-pypi-publish@release/v1

README.md

@@ -13,9 +13,20 @@
 
 ## Installation
 
-`multispaeti` will be made available on [PyPi](https://pypi.org/) and
-[conda-forge](https://conda-forge.org/). For detailed installation instructions
-please refer to the [documentation](https://multispaeti.readthedocs.io/en/stable/installation.html).
+`multispaeti` is available from [PyPI](https://pypi.org/project/multispaeti/)
+
+```bash
+pip install multispaeti
+```
+
+and [conda-forge](https://anaconda.org/conda-forge/multispaeti)
+
+```bash
+conda install conda-forge::multispaeti
+```
+
+For detailed installation instructions please refer to the
+[documentation](https://multispaeti.readthedocs.io/en/stable/installation.html).
 
 ## Documentation
 

docs/source/api.rst

@@ -2,11 +2,11 @@ API
 ===
 
 
-The API for :py:class:`multispaeti.MultispatiPCA` tries to follow the design in
-`scikit-learn <https://scikit-learn.org/>`_. The plan is to make it fully compatible in
-the future by inheriting from :py:class:`sklearn.base.BaseEstimator` and
-:py:class:`sklearn.base.TransformerMixin`.
-
+The API for :py:class:`multispaeti.MultispatiPCA` follows the design in
+`scikit-learn <https://scikit-learn.org/>`_. It inherits from
+:py:class:`sklearn.base.BaseEstimator`, :py:class:`sklearn.base.TransformerMixin`, and
+:py:class:`sklearn.base.ClassNamePrefixFeaturesOutMixin` making it fully compatible
+with `scikit-learn` pipelines.
 
 
 .. currentmodule:: multispaeti

docs/source/installation.rst

@@ -2,34 +2,29 @@ Installation
 ============
 
 
-PyPi and ``pip``
+PyPI and ``pip``
 ----------------
 
-``multispaeti`` will soon be available to install from `PyPi <https://pypi.org/>`_.
+To install ``multispaeti`` from `PyPI <https://pypi.org/>`_ using ``pip`` just run
 
-.. To install ``multispaeti`` from `PyPi <https://pypi.org/>`_ using ``pip`` just run
-
-.. .. code-block:: bash
+.. code-block:: bash
 
-..     pip install multispaeti
+    pip install multispaeti
 
 
 conda-forge and ``conda``
 -------------------------
 
-``multispaeti`` is not yet available for
-`Miniconda <https://docs.conda.io/en/latest/miniconda.html>`_ installations. But we are
-planning to add it to `conda-forge <https://conda-forge.org/>`_ soon.
+``multispaeti`` can also be installed from `conda-forge <https://conda-forge.org/>`_ via
 
+.. code-block:: bash
 
-.. .. code-block:: bash
-
-..     conda install -c conda-forge multispaeti
+    conda install conda-forge::multispaeti
 
-.. .. note::
+.. note::
 
-..     Of course, it is also possible to use ``mamba`` instead of ``conda``
-..     to speed up the installation.
+    Of course, it is also possible to use ``mamba`` instead of ``conda``
+    to speed up the installation.
 
 
 From GitHub

docs/source/usage.rst

@@ -37,8 +37,9 @@ As for e.g. :py:class:`sklearn.decomposition.PCA` we first need to
     msPCA.fit(X)
     X_transformed = msPCA.transform(X)
 
+
 Alternatively, this can be achieved in one step by
-:py:meth:`multispaeti.MultispatiPCA.fit_transform`
+:py:meth:`multispaeti.MultispatiPCA.fit_transform` which avoids redundant computation.
 
 .. code-block:: python