PedestrianDynamics · schroedtert · Oct 4, 2023 · Oct 4, 2023 · Oct 4, 2023 · Oct 4, 2023
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -9,7 +9,7 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.10"
+    python: "3.11"
 
   jobs:
     pre_build:

diff --git a/CITATION.cff b/CITATION.cff
@@ -19,5 +19,8 @@ license: MIT
 identifiers:
   - description: This is the collection of archived snapshots of all versions of PedPy
     type: doi
-    value: "10.5281/zenodo.8254431"
-version: 1.0.0rc3
+    value: "10.5281/zenodo.7194992"
+  - description: This is the archived snapshot of version 1.0.0 of PedPy
+    type: doi
+    value: "10.5281/zenodo.8405437"
+version: 1.0.1
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@
 [![PyPI Latest Release](https://img.shields.io/pypi/v/pedpy.svg)](https://pypi.org/project/pedpy/)
 [![Nightly Release](https://img.shields.io/badge/nightly-install-9cf)](https://test.pypi.org/project/PedPy/)
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pedpy)
-[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7386931.svg)](https://doi.org/10.5281/zenodo.7386931)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7194992.svg)](https://doi.org/10.5281/zenodo.7194992)
 [![License](https://img.shields.io/pypi/l/pedpy.svg)](https://github.com/PedestrianDynamics/pedpy/blob/main/LICENSE)
 ![ci workflow](https://github.com/PedestrianDynamics/pedestrian-trajectory-analyzer/actions/workflows/ci.yml/badge.svg)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
@@ -23,7 +23,7 @@ It implements different measurement methods for density, velocity and flow.
 
 If you use *PedPy* in your work, please cite it using the following information from zenodo:
 
-[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7386931.svg)](https://doi.org/10.5281/zenodo.7386931)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7194992.svg)](https://doi.org/10.5281/zenodo.7194992)
 
 
 ## Getting started

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,11 +1,11 @@
-sphinx~=5.3.0
+sphinx~=6.2.1
 sphinx-copybutton==0.5.2
 sphinx_design==0.5.0
-myst-nb==0.17.2
-nbconvert==7.7.1
-sphinx-notfound-page==0.8.3
+myst-nb @ git+https://github.com/executablebooks/MyST-NB@59854c2
+nbconvert==7.9.0
+sphinx-notfound-page==1.0.0
 sphinx-favicon==1.0.1
 sphinx-book-theme==1.0.1
-sphinx-autoapi==2.1.1
+sphinx-autoapi==3.0.0
 h5py~=3.9.0
 tables~=3.8.0
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -0,0 +1,15 @@
+*********
+Changelog
+*********
+
+Version 1.0.1 (2023-10-04)
+==========================
+
+Fixes:
+
+- Add correct doi badge to documentation and readme
+
+Version 1.0.0 (2023-09-22)
+==========================
+
+First release of *PedPy*.
diff --git a/docs/source/citation.rst b/docs/source/citation.rst
@@ -2,9 +2,16 @@
 Cite PedPy
 **********
 
-If you use *PedPy* in your work, please cite it using the following information from zenodo:
+If you use *PedPy* in your work, please cite it using the following information from zenodo.
+Here you can find all versions of PedPy with this link:
 
-.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.8254431.svg
-   :target: https://doi.org/10.5281/zenodo.8254431
+.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7194992.svg
+   :target: https://doi.org/10.5281/zenodo.7194992
 
+You can find out the installed version of *PedPy* with:
+
+.. code-block:: bash
+
+    import pedpy
+    print(pedpy.__version__)
 
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -126,8 +126,8 @@
         },
         {
             "name": "DOI",
-            "url": "https://doi.org/10.5281/zenodo.8254431",
-            "icon": "https://zenodo.org/badge/DOI/10.5281/zenodo.8254431.svg",
+            "url": "https://doi.org/10.5281/zenodo.7194992",
+            "icon": "https://zenodo.org/badge/DOI/10.5281/zenodo.7194992.svg",
             "type": "url",
         },
     ],

diff --git a/docs/source/developer_guide.rst b/docs/source/developer_guide.rst
@@ -17,6 +17,7 @@ So don't hesitate to reach out with any questions or ideas you may have. We look
 
 Reporting bugs
 ==============
+
 At *PedPy*, we value feedback from our users, and we encourage you to report any issues or bugs that you encounter while using the library.
 You can do this by visiting our `GitHub issues page <https://github.com/PedestrianDynamics/PedPy/issues>`_.
 From there, you can submit a new issue, provide a detailed description of the problem, and even include code snippets or screenshots to help us better understand the issue.

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -11,6 +11,7 @@ PedPy: Pedestrian Trajectory Analyzer
    API Reference <api/index>
    Developer Guide <developer_guide>
    Cite PedPy <citation>
+   Changelog <changelog>
    Disclaimer <disclaimer>
 
 
@@ -38,10 +39,18 @@ Install PedPy
 Cite PedPy
 ==========
 
-If you use *PedPy* in your work, please cite it using the following information from zenodo:
+If you use *PedPy* in your work, please cite it using the following information from zenodo.
+Here you can find all versions of PedPy with this link:
 
-.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.8254431.svg
-   :target: https://doi.org/10.5281/zenodo.8254431
+.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7194992.svg
+   :target: https://doi.org/10.5281/zenodo.7194992
+
+You can find out the installed version of *PedPy* with:
+
+.. code-block:: bash
+
+    import pedpy
+    print(pedpy.__version__)
 
 |
 

diff --git a/pedpy/column_identifier.py b/pedpy/column_identifier.py
@@ -2,7 +2,6 @@
 
 from typing import Final
 
-# TrajectoryData
 ID_COL: Final = "id"
 FRAME_COL: Final = "frame"
 X_COL: Final = "x"

diff --git a/pedpy/methods/speed_calculator.py b/pedpy/methods/speed_calculator.py
@@ -71,6 +71,7 @@ def compute_individual_speed(
     This then can be used to compute the speed with:
 
     .. math::
+
         \bar{X} = X_{future} - X_{past}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -71,6 +71,7 @@ def compute_individual_speed(
		This then can be used to compute the speed with:

		.. math::

		\bar{X} = X_{future} - X_{past}


Expand Down