From b6a769335107fe021966919d613b2b5d35d4cba9 Mon Sep 17 00:00:00 2001
From: AliciaRoh <nero.ro@web.de>
Date: Thu, 30 May 2024 13:11:27 +0200
Subject: [PATCH 1/9] Formatting variable

---
 seismostats/utils/binning.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/seismostats/utils/binning.py b/seismostats/utils/binning.py
index be22e0e..2ccafef 100644
--- a/seismostats/utils/binning.py
+++ b/seismostats/utils/binning.py
@@ -41,7 +41,7 @@ def normal_round(x: float, n: int = 0) -> float:
 def bin_to_precision(x: np.ndarray | list, delta_x: float = 0.1) -> np.ndarray:
     """
     Rounds a float number x to a given precision. If precision not given,
-    assumes 0.1 bin size
+    assumes ``delta_x = 0.1``
 
     Args:
         x: decimal number that needs to be rounded

From 00755b7978a0311421c23b99eca63994d382dcd1 Mon Sep 17 00:00:00 2001
From: AliciaRoh <nero.ro@web.de>
Date: Thu, 30 May 2024 13:19:27 +0200
Subject: [PATCH 2/9] formatting for documentation

---
 seismostats/utils/binning.py | 24 +++++++++++++-----------
 1 file changed, 13 insertions(+), 11 deletions(-)

diff --git a/seismostats/utils/binning.py b/seismostats/utils/binning.py
index 2ccafef..b2504b0 100644
--- a/seismostats/utils/binning.py
+++ b/seismostats/utils/binning.py
@@ -23,7 +23,7 @@ def normal_round_to_int(x: float) -> int:
 
 def normal_round(x: float, n: int = 0) -> float:
     """
-    Rounds a float number x to n number of decimals. If the number
+    Rounds a float number ``x`` to n number of decimals. If the number
     of decimals is not given, we round to an integer.
 
     Args:
@@ -40,11 +40,11 @@ def normal_round(x: float, n: int = 0) -> float:
 
 def bin_to_precision(x: np.ndarray | list, delta_x: float = 0.1) -> np.ndarray:
     """
-    Rounds a float number x to a given precision. If precision not given,
-    assumes ``delta_x = 0.1``
+    Rounds float numbers within the array ``x`` to a given precision. If precision not given,
+    assumes ``delta_x = 0.1``.
 
     Args:
-        x: decimal number that needs to be rounded
+        x: list of decimal numbers that needs to be rounded
         delta_x: size of the bin, optional
 
     Returns:
@@ -63,9 +63,10 @@ def bin_to_precision(x: np.ndarray | list, delta_x: float = 0.1) -> np.ndarray:
 def get_fmd(
     mags: np.ndarray, delta_m: float, bin_position: str = "center"
 ) -> tuple[np.ndarray, np.ndarray, np.ndarray]:
-    """Calculates event counts per magnitude bin. Note that the returned bins
-        array contains the center point of each bin unless bin_position is
-        'left'.
+    """
+    Calculates event counts per magnitude bin. Note that the returned bins
+    array contains the center point of each bin unless ``bin_position = 'left'``.
+
 
     Args:
         mags    : array of magnitudes
@@ -75,7 +76,7 @@ def get_fmd(
                         returned.
     Returns:
         bins    : array of bin centers (left to right)
-        counts  : counts for each bin ("")
+        counts  : counts for each bin
         mags    : array of magnitudes binned to delta_m
     """
     mags = bin_to_precision(mags, delta_m)
@@ -105,9 +106,10 @@ def get_fmd(
 def get_cum_fmd(
     mags: np.ndarray, delta_m: float, bin_position: str = "center"
 ) -> tuple[np.ndarray, np.ndarray, np.ndarray]:
-    """Calculates cumulative event counts across all magnitude units
+    """
+    Calculates cumulative event counts across all magnitude units
     (summed from the right). Note that the returned bins array contains
-    the center point of each bin unless left is True.
+    the center point of each bin unless ``bin_position = 'left'``.
 
     Args:
         mags    : array of magnitudes
@@ -118,7 +120,7 @@ def get_cum_fmd(
 
     Returns:
         bins    : array of bin centers (left to right)
-        c_counts: cumulative counts for each bin ("")
+        c_counts: cumulative counts for each bin
         mags    : array of magnitudes binned to delta_m
     """
 

From 6780f64c92a50fb218aa4e00902b572a64a3ad3a Mon Sep 17 00:00:00 2001
From: AliciaRoh <nero.ro@web.de>
Date: Thu, 30 May 2024 13:22:09 +0200
Subject: [PATCH 3/9] import binning function in utils

---
 seismostats/utils/__init__.py | 1 +
 1 file changed, 1 insertion(+)

diff --git a/seismostats/utils/__init__.py b/seismostats/utils/__init__.py
index 23a5d56..579d676 100644
--- a/seismostats/utils/__init__.py
+++ b/seismostats/utils/__init__.py
@@ -2,6 +2,7 @@
 
 import pandas as pd
 from jinja2 import Template, select_autoescape
+from seismostats.utils.binning import bin_to_precision, get_cum_fmd, get_fmd
 
 
 def _check_required_cols(df: pd.DataFrame,

From 69349b8948212aa08edea36539d732d1421935ca Mon Sep 17 00:00:00 2001
From: AliciaRoh <nero.ro@web.de>
Date: Thu, 30 May 2024 13:39:24 +0200
Subject: [PATCH 4/9] documentation

---
 docs/source/reference/index.md              |  1 +
 docs/source/reference/utils.md              | 28 +++++++++++++++++++++
 seismostats/utils/__init__.py               |  2 ++
 seismostats/utils/binning.py                |  4 +--
 seismostats/utils/simulate_distributions.py | 12 +++++----
 5 files changed, 40 insertions(+), 7 deletions(-)
 create mode 100644 docs/source/reference/utils.md

diff --git a/docs/source/reference/index.md b/docs/source/reference/index.md
index 28dba38..77c2e27 100644
--- a/docs/source/reference/index.md
+++ b/docs/source/reference/index.md
@@ -7,4 +7,5 @@ catalog
 config
 plots
 analysis
+utils
 ```
\ No newline at end of file
diff --git a/docs/source/reference/utils.md b/docs/source/reference/utils.md
new file mode 100644
index 0000000..49e751f
--- /dev/null
+++ b/docs/source/reference/utils.md
@@ -0,0 +1,28 @@
+# Utils
+
+```{eval-rst}
+.. currentmodule:: seismostats
+```
+
+## Binning
+
+```{eval-rst}
+.. autosummary::
+    :toctree: api/
+
+    bin_to_precision
+    utils.get_fmd
+    utils.get_cum_fmd
+
+```
+
+## Synthetic Magnitudes
+
+```{eval-rst}
+.. autosummary::
+    :toctree: api/
+
+    utils.simulate_magnitudes
+    utils.simulated_magnitudes_binned
+
+```
\ No newline at end of file
diff --git a/seismostats/utils/__init__.py b/seismostats/utils/__init__.py
index 579d676..f68452a 100644
--- a/seismostats/utils/__init__.py
+++ b/seismostats/utils/__init__.py
@@ -3,6 +3,8 @@
 import pandas as pd
 from jinja2 import Template, select_autoescape
 from seismostats.utils.binning import bin_to_precision, get_cum_fmd, get_fmd
+from seismostats.utils.simulate_distributions import (simulate_magnitudes,
+                                                      simulated_magnitudes_binned)  # noqa
 
 
 def _check_required_cols(df: pd.DataFrame,
diff --git a/seismostats/utils/binning.py b/seismostats/utils/binning.py
index b2504b0..9ffc69f 100644
--- a/seismostats/utils/binning.py
+++ b/seismostats/utils/binning.py
@@ -77,7 +77,7 @@ def get_fmd(
     Returns:
         bins    : array of bin centers (left to right)
         counts  : counts for each bin
-        mags    : array of magnitudes binned to delta_m
+        mags    : array of magnitudes binned to ``delta_m``
     """
     mags = bin_to_precision(mags, delta_m)
     mags_i = bin_to_precision(mags / delta_m - np.min(mags / delta_m), 1)
@@ -121,7 +121,7 @@ def get_cum_fmd(
     Returns:
         bins    : array of bin centers (left to right)
         c_counts: cumulative counts for each bin
-        mags    : array of magnitudes binned to delta_m
+        mags    : array of magnitudes binned to ``delta_m``
     """
 
     if delta_m == 0:
diff --git a/seismostats/utils/simulate_distributions.py b/seismostats/utils/simulate_distributions.py
index 36dacb7..cf674ed 100644
--- a/seismostats/utils/simulate_distributions.py
+++ b/seismostats/utils/simulate_distributions.py
@@ -6,7 +6,8 @@
 def simulate_magnitudes(
     n: int, beta: float, mc: float, mag_max: float | None = None
 ) -> np.ndarray:
-    """Generates a vector of n elements drawn from an exponential distribution
+    """
+    Generates a vector of ``n`` elements drawn from an exponential distribution
     exp(-beta*M)
 
     Args:
@@ -42,14 +43,15 @@ def simulated_magnitudes_binned(
     mag_max: float = None,
     b_parameter: str = "b_value",
 ) -> np.ndarray:
-    """simulate magnitudes and bin them to a given precision. input 'b' can be
-    specified to be beta or the b-value, depending on the 'b_parameter' input
+    """
+    Simulate magnitudes and bin them to a given precision ``delta_m``. Input ``b`` can be
+    specified to be 'beta' or the 'b-value', depending on the ``b_parameter`` input.
 
     Args:
         n:              number of magnitudes to simulate
         b:              b-value or beta of the distribution from which
-                magnitudes are simulated. If b is np.ndarray, it must have the
-                length n. Then each magnitude is simulated from the
+                magnitudes are simulated. If ``b`` is np.ndarray, it must have the
+                length ``n``. Then each magnitude is simulated from the
                 corresponding b-value
         mc:             completeness magnitude
         delta_m:        magnitude bin width

From 1ab20c3e10ba372a7b68ad2c6f61977282bdbb7c Mon Sep 17 00:00:00 2001
From: AliciaRoh <nero.ro@web.de>
Date: Thu, 30 May 2024 14:58:51 +0200
Subject: [PATCH 5/9] formatting for documentation of utils

---
 docs/source/reference/utils.md              | 24 ++++++-
 seismostats/utils/__init__.py               | 12 +++-
 seismostats/utils/binning.py                |  8 +--
 seismostats/utils/coordinates.py            | 70 ++++++++++++++++-----
 seismostats/utils/filtering.py              | 25 ++++----
 seismostats/utils/simulate_distributions.py | 11 ++--
 6 files changed, 106 insertions(+), 44 deletions(-)

diff --git a/docs/source/reference/utils.md b/docs/source/reference/utils.md
index 49e751f..d24e615 100644
--- a/docs/source/reference/utils.md
+++ b/docs/source/reference/utils.md
@@ -16,7 +16,7 @@
 
 ```
 
-## Synthetic Magnitudes
+## Synthetic Magnitude Distributions
 
 ```{eval-rst}
 .. autosummary::
@@ -25,4 +25,26 @@
     utils.simulate_magnitudes
     utils.simulated_magnitudes_binned
 
+```
+
+## Coordinates
+
+```{eval-rst}
+.. autosummary::
+    :toctree: api/
+
+    utils.CoordinateTransformer
+    utils.bounding_box_to_polygon
+    utils.polygon_to_bounding_box
+
+```
+
+## Spatial Filtering
+
+```{eval-rst}
+.. autosummary::
+    :toctree: api/
+
+    utils.cat_intersect_polygon
+
 ```
\ No newline at end of file
diff --git a/seismostats/utils/__init__.py b/seismostats/utils/__init__.py
index f68452a..fa26052 100644
--- a/seismostats/utils/__init__.py
+++ b/seismostats/utils/__init__.py
@@ -2,9 +2,15 @@
 
 import pandas as pd
 from jinja2 import Template, select_autoescape
-from seismostats.utils.binning import bin_to_precision, get_cum_fmd, get_fmd
-from seismostats.utils.simulate_distributions import (simulate_magnitudes,
-                                                      simulated_magnitudes_binned)  # noqa
+from seismostats.utils.binning import (bin_to_precision,   # noqa
+                                       get_cum_fmd,
+                                       get_fmd)
+from seismostats.utils.simulate_distributions import (  # noqa
+    simulate_magnitudes, simulated_magnitudes_binned)
+from seismostats.utils.filtering import cat_intersect_polygon  # noqa
+from seismostats.utils.coordinates import (CoordinateTransformer,  # noqa
+                                           bounding_box_to_polygon,
+                                           polygon_to_bounding_box)
 
 
 def _check_required_cols(df: pd.DataFrame,
diff --git a/seismostats/utils/binning.py b/seismostats/utils/binning.py
index 9ffc69f..78240c8 100644
--- a/seismostats/utils/binning.py
+++ b/seismostats/utils/binning.py
@@ -40,8 +40,8 @@ def normal_round(x: float, n: int = 0) -> float:
 
 def bin_to_precision(x: np.ndarray | list, delta_x: float = 0.1) -> np.ndarray:
     """
-    Rounds float numbers within the array ``x`` to a given precision. If precision not given,
-    assumes ``delta_x = 0.1``.
+    Rounds float numbers within the array ``x`` to a given precision. If
+    precision not given, assumes ``delta_x = 0.1``.
 
     Args:
         x: list of decimal numbers that needs to be rounded
@@ -65,8 +65,8 @@ def get_fmd(
 ) -> tuple[np.ndarray, np.ndarray, np.ndarray]:
     """
     Calculates event counts per magnitude bin. Note that the returned bins
-    array contains the center point of each bin unless ``bin_position = 'left'``.
-
+    array contains the center point of each bin unless
+    ``bin_position = 'left'``.
 
     Args:
         mags    : array of magnitudes
diff --git a/seismostats/utils/coordinates.py b/seismostats/utils/coordinates.py
index aa27291..f8e8252 100644
--- a/seismostats/utils/coordinates.py
+++ b/seismostats/utils/coordinates.py
@@ -11,7 +11,7 @@ class CoordinateTransformer:
     Class to transform between a external geographic (default ESPG:4326,
     also known as WGS84), and a local cartesian CRS.
 
-    Any EPSG code or proj4 string can be used for the local_proj input,
+    Any EPSG code or proj4 string can be used for the ``local_proj`` input,
     for instance 2056 to represent the swiss coordinate system, or
     "+proj=utm +zone=32 +ellps=WGS84 +datum=WGS84 +units=m +no_defs"
     to represent a UTM coordinate system.
@@ -30,12 +30,12 @@ def __init__(
             external_proj: int | str = 4326):
         """
         Constructor of CoordinateTransformer object.
-
-        :param local_proj: int (epsg) or string (proj) of local CRS.
-        :param ref_easting: reference easting for local coordinates.
-        :param ref_northing: reference northing for local coordinates.
-        :param ref_altitude: reference altitude for local coordinates.
-        :param external_proj: int or string of geographic coordinates.
+        Args:
+            local_proj: int (epsg) or string (proj) of local CRS.
+            ref_easting: reference easting for local coordinates.
+            ref_northing: reference northing for local coordinates.
+            ref_altitude: reference altitude for local coordinates.
+            external_proj: int or string of geographic coordinates.
         """
         self.ref_easting = ref_easting
         self.ref_northing = ref_northing
@@ -54,11 +54,13 @@ def to_local_coords(self,
                         altitude: float | list = None):
         """
         Transform geographic coordinates to local coordinates.
+        Args:
+            lon: longitude
+            lat: latitude
+            altitude: altitude
 
-        :param lon: longitude
-        :param lat: latitude
-        :param altitude: altitude
-        :returns: Easting, northing and altitude in local CRS relative to ref.
+        Returns:
+            Easting, northing and altitude in local CRS relative to ref.
         """
         enu = \
             self.transformer_to_local.transform(lon, lat, altitude)
@@ -80,10 +82,13 @@ def from_local_coords(
         """
         Transform local coordinates to geographic coordinates.
 
-        :param easting: easting
-        :param northing: northing
-        :param altitude: altitude
-        :returns: longitude, latitude, altitude in local CRS relative to ref.
+        Args:
+            easting: easting
+            northing: northing
+            altitude: altitude
+
+        Returns:
+            longitude, latitude, altitude in local CRS relative to ref.
         """
         easting_0 = np.array(easting) + self.ref_easting
         northing_0 = np.array(northing) + self.ref_northing
@@ -103,7 +108,13 @@ def from_local_coords(
 
     def polygon_to_local_coords(self, polygon: Polygon) -> Polygon:
         """
-        Transform polygon to local coordinates.
+        Transform polygon from geographic coordinates to local coordinates.
+
+        Args:
+            polygon: shapely polygon
+
+        Returns:
+            shapely polygon in local coordinates
         """
         new_polygon = transform(
             self.transformer_to_local.transform, polygon)
@@ -114,7 +125,13 @@ def polygon_to_local_coords(self, polygon: Polygon) -> Polygon:
 
     def polygon_from_local_coords(self, polygon: Polygon) -> Polygon:
         """
-        Transform polygon to local coordinates.
+        Transform polygon from local coordinates to geographic coordinates.
+
+        Args:
+            polygon: shapely polygon
+
+        Returns:
+            shapely polygon in geographic coordinates
         """
         translated_polygon = translate(
             polygon, xoff=self.ref_easting,
@@ -125,6 +142,16 @@ def polygon_from_local_coords(self, polygon: Polygon) -> Polygon:
 
 
 def bounding_box_to_polygon(x_min, x_max, y_min, y_max, srid=None) -> Polygon:
+    """
+    Create a shapely Polygon from a bounding box.
+
+    Args:
+        x_min: minimum x coordinate
+        x_max: maximum x coordinate
+        y_min: minimum y coordinate
+        y_max: maximum y coordinate
+        srid: spatial reference system identifier
+    """
     bbox = (x_min, y_min,
             x_max, y_max)
     return geometry.box(*bbox, ccw=True)
@@ -132,5 +159,14 @@ def bounding_box_to_polygon(x_min, x_max, y_min, y_max, srid=None) -> Polygon:
 
 def polygon_to_bounding_box(polygon: Polygon) -> \
         tuple[float, float, float, float]:
+    """
+    Get the bounding box of a Polygon.
+
+    Args:
+        polygon: shapely Polygon
+
+    Returns:
+        tuple: The corner coordinates of the Polygon
+    """
     (minx, miny, maxx, maxy) = polygon.bounds
     return (minx, miny, maxx, maxy)
diff --git a/seismostats/utils/filtering.py b/seismostats/utils/filtering.py
index c6e7505..73aed76 100644
--- a/seismostats/utils/filtering.py
+++ b/seismostats/utils/filtering.py
@@ -2,23 +2,20 @@
 from shapely.geometry import Point, Polygon
 
 
-def cat_intersect_polygon(cat: pd.DataFrame, polygon_vertices: list[tuple]
-                          ) -> pd.DataFrame:
-    """Returns a DataFrame containing
-    only the rows with points inside a given polygon.
+def cat_intersect_polygon(
+        cat: pd.DataFrame,
+        polygon_vertices: list[tuple]) -> pd.DataFrame:
+    """
+    Returns a DataFrame containing only the rows with points inside a given
+    polygon.
 
-    Args:
-    -----------
-    cat : pandas.DataFrame
-        DataFrame with columns 'latitude' and 'longitude'
-        containing the points to be checked.
-    polygon_vertices : list of tuples
-        List of (x, y) tuples representing
-        the vertices of the polygon to be checked against.
+        Args:
+        cat : DataFrame with columns 'latitude' and 'longitude' containing the
+              points to be checked.
+        polygon_vertices : List of (x, y) tuples representing
+                           the vertices of the polygon to be checked against.
 
     Returns:
-    --------
-    pandas.DataFrame
         DataFrame containing only the rows with points inside the polygon.
 
     """
diff --git a/seismostats/utils/simulate_distributions.py b/seismostats/utils/simulate_distributions.py
index cf674ed..f2df665 100644
--- a/seismostats/utils/simulate_distributions.py
+++ b/seismostats/utils/simulate_distributions.py
@@ -8,7 +8,7 @@ def simulate_magnitudes(
 ) -> np.ndarray:
     """
     Generates a vector of ``n`` elements drawn from an exponential distribution
-    exp(-beta*M)
+    :math:`f = e^{-beta*M}`.
 
     Args:
         n:      number of sample magnitudes
@@ -44,14 +44,15 @@ def simulated_magnitudes_binned(
     b_parameter: str = "b_value",
 ) -> np.ndarray:
     """
-    Simulate magnitudes and bin them to a given precision ``delta_m``. Input ``b`` can be
-    specified to be 'beta' or the 'b-value', depending on the ``b_parameter`` input.
+    Simulate magnitudes and bin them to a given precision ``delta_m``.
+    Input ``b`` can be specified to be 'beta' or the 'b-value',
+    depending on the ``b_parameter`` input.
 
     Args:
         n:              number of magnitudes to simulate
         b:              b-value or beta of the distribution from which
-                magnitudes are simulated. If ``b`` is np.ndarray, it must have the
-                length ``n``. Then each magnitude is simulated from the
+                magnitudes are simulated. If ``b`` is np.ndarray, it must have
+                the length ``n``. Then each magnitude is simulated from the
                 corresponding b-value
         mc:             completeness magnitude
         delta_m:        magnitude bin width

From 2472cf2f6f385ce831335420772ff910ba7cfd44 Mon Sep 17 00:00:00 2001
From: AliciaRoh <nero.ro@web.de>
Date: Thu, 30 May 2024 15:05:56 +0200
Subject: [PATCH 6/9] comment the class internal functions, so they are not
 shown

---
 docs/source/reference/utils.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/docs/source/reference/utils.md b/docs/source/reference/utils.md
index d24e615..430d5ec 100644
--- a/docs/source/reference/utils.md
+++ b/docs/source/reference/utils.md
@@ -34,6 +34,10 @@
     :toctree: api/
 
     utils.CoordinateTransformer
+    [//]: <> utils.CoordinateTransformer.to_local_coords
+    [//]: <> utils.CoordinateTransformer.from_local_coords
+    [//]: <> utils.CoordinateTransformer.polygon_from_local_coords
+    [//]: <> utils.CoordinateTransformer.polygon_to_local_coords
     utils.bounding_box_to_polygon
     utils.polygon_to_bounding_box
 

From 145fac997d3fa48c0fb906770423269dc6123df2 Mon Sep 17 00:00:00 2001
From: AliciaRoh <nero.ro@web.de>
Date: Thu, 30 May 2024 15:06:09 +0200
Subject: [PATCH 7/9] formatting

---
 seismostats/utils/coordinates.py | 1 +
 1 file changed, 1 insertion(+)

diff --git a/seismostats/utils/coordinates.py b/seismostats/utils/coordinates.py
index f8e8252..6cf966b 100644
--- a/seismostats/utils/coordinates.py
+++ b/seismostats/utils/coordinates.py
@@ -54,6 +54,7 @@ def to_local_coords(self,
                         altitude: float | list = None):
         """
         Transform geographic coordinates to local coordinates.
+
         Args:
             lon: longitude
             lat: latitude

From 7c077086293113c5f25fbdb8d284450af77ae62f Mon Sep 17 00:00:00 2001
From: AliciaRoh <nero.ro@web.de>
Date: Wed, 5 Jun 2024 09:06:30 +0200
Subject: [PATCH 8/9] formatting

---
 seismostats/utils/filtering.py | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/seismostats/utils/filtering.py b/seismostats/utils/filtering.py
index 73aed76..f4a9a13 100644
--- a/seismostats/utils/filtering.py
+++ b/seismostats/utils/filtering.py
@@ -2,14 +2,13 @@
 from shapely.geometry import Point, Polygon
 
 
-def cat_intersect_polygon(
-        cat: pd.DataFrame,
-        polygon_vertices: list[tuple]) -> pd.DataFrame:
+def cat_intersect_polygon(cat: pd.DataFrame, polygon_vertices: list[tuple]
+                          ) -> pd.DataFrame:
     """
     Returns a DataFrame containing only the rows with points inside a given
     polygon.
 
-        Args:
+    Args:
         cat : DataFrame with columns 'latitude' and 'longitude' containing the
               points to be checked.
         polygon_vertices : List of (x, y) tuples representing

From f9d3d8af7614cd68f953b82202f30b59bd2ebdfb Mon Sep 17 00:00:00 2001
From: Aron Mirwald <aron.mirwald@sed.ethz.ch>
Date: Wed, 5 Jun 2024 09:49:11 +0200
Subject: [PATCH 9/9] spelling correct

---
 docs/source/index.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/source/index.md b/docs/source/index.md
index 6d7cb17..6f86ffb 100644
--- a/docs/source/index.md
+++ b/docs/source/index.md
@@ -5,7 +5,7 @@ User Guide <user/index>
 API reference <reference/index>
 ```
 
-# Seismo Stats
+# SeismoStats
 
 Analyse your seismic catalogues with **SeismoStats**, a Python package for seismicity analysis.