Merge pull request #9 from maicos-devel/update-readme

Quewakira · web-flow · commit 77a0b07e237a · 2025-11-05T15:30:50.000+01:00
Add new modules to README and add Usage Python Doc
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -10,11 +10,11 @@ CHANGELOG file
     use tabs but use spaces for formatting
 
 
-Unreleased v0.0.1 (2025/08/05)
-------------------------------
+Unreleased
+----------
 Kira Fischer, Philip Loche, Henrik Stooß
 
-- Migrated ``RDFDiporder`` and ``DiporderStructureFactor`` from MAICoS
+- Migrate ``RDFDiporder`` and ``DiporderStructureFactor`` from MAICoS
 - Update the documentation (#8)
 - Update to Python 3.14 support
 - Updated the docs with Whatis section
diff --git a/README.rst b/README.rst
@@ -62,6 +62,10 @@ Currently, Scatterkit supports the following analysis modules (alphabetically):
 
    * - Module
      - Description
+   * - DiporderStructureFactor
+     - Structure factor for dipoles
+   * - RDFDiporder
+     - Radial distribution function between dipoles
    * - SAXS
      - Small angle X-ray scattering
 
diff --git a/docs/src/get-started/index.rst b/docs/src/get-started/index.rst
@@ -10,6 +10,7 @@ This sections describes Scatterkit, how to install it, and its most basic comman
 
     scatterkit
     installation
+    usage-python
     ../examples/usage-bash
     units
     changelog
diff --git a/docs/src/get-started/usage-python.rst b/docs/src/get-started/usage-python.rst
@@ -0,0 +1,12 @@
+Usage - Python Interpreter
+==========================
+
+To use Scatterkit using the Python interpreter see
+
+- the How-To: :ref:`howto-saxs`,
+- or the `MAICoS tutorial`_, for a more basic introduction.
+  Scatterkit follows the same principles as MAICoS,
+  the Molecular Analysis for Interfacial and Confined Systems toolkit.
+
+.. _MAICOS tutorial:
+   https://maicos-analysis.org/stable/examples/usage-python.html
