Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -315,6 +315,8 @@ cython_debug/
*.code-workspace

docs/build
docs/jupyter_execute
docs/source/results_introduction/
pedpy/_version.py
docs/source/ZENODO.rst
notebooks/results_introduction
Expand Down
156 changes: 156 additions & 0 deletions LICENSES/CC-BY-4.0.txt

Large diffs are not rendered by default.

22 changes: 22 additions & 0 deletions LICENSES/MIT.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
MIT License

Copyright (c) 2022-2025 Forschungszentrum Jülich GmbH, IAS-7
Copyright (c) 2024-2025 Tobias Schrödter

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
40 changes: 40 additions & 0 deletions REUSE.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
version = 1

[[annotations]]
path = [
"pedpy/**",
"tests/**/*.py",
"scripts/**",
"notebooks/**",
"helper/**",
"docs/**/*.py","docs/**/*.rst",
"*",
".github/**"
]
SPDX-FileCopyrightText = [
"2022-2025 Forschungszentrum Jülich GmbH, IAS-7",
"2024-2025 Tobias Schrödter"
]
SPDX-License-Identifier = "MIT"

[[annotations]]
path = [
"docs/**",
"figs/**",
]
SPDX-FileCopyrightText = [
"2022-2025 Forschungszentrum Jülich GmbH, IAS-7",
"2024-2025 Tobias Schrödter"
]
SPDX-License-Identifier = "CC-BY-4.0"

[[annotations]]
path = [
"tests/reference_tests/data/**",
"tests/unit_tests/io/test-data/**"
]
precedence = "override"
SPDX-FileCopyrightText = [
"2022-2025 Forschungszentrum Jülich GmbH, IAS-7",
]
SPDX-License-Identifier = "CC-BY-4.0"
5 changes: 5 additions & 0 deletions pedpy/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: Copyright (C) 2022-2025 Forschungszentrum Jülich GmbH, IAS-7
# SPDX-FileCopyrightText: Copyright (C) 2024-2025 Tobias Schrödter
#
# SPDX-License-Identifier: MIT

"""Top level imports, for easier usage."""

try:
Expand Down
5 changes: 5 additions & 0 deletions pedpy/column_identifier.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: Copyright (C) 2022-2025 Forschungszentrum Jülich GmbH, IAS-7
# SPDX-FileCopyrightText: Copyright (C) 2024-2025 Tobias Schrödter
#
# SPDX-License-Identifier: MIT

"""Description of the used columns names in PedPy."""

from typing import Final
Expand Down
5 changes: 5 additions & 0 deletions pedpy/data/geometry.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: Copyright (C) 2022-2025 Forschungszentrum Jülich GmbH, IAS-7
# SPDX-FileCopyrightText: Copyright (C) 2024-2025 Tobias Schrödter
#
# SPDX-License-Identifier: MIT

"""Module handling the geometrical environment of the analysis."""

from dataclasses import dataclass
Expand Down
5 changes: 5 additions & 0 deletions pedpy/data/trajectory_data.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: Copyright (C) 2022-2025 Forschungszentrum Jülich GmbH, IAS-7
# SPDX-FileCopyrightText: Copyright (C) 2024-2025 Tobias Schrödter
#
# SPDX-License-Identifier: MIT

"""Module handling the trajectory data of the analysis."""

from __future__ import annotations
Expand Down
5 changes: 5 additions & 0 deletions pedpy/errors.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: Copyright (C) 2022-2025 Forschungszentrum Jülich GmbH, IAS-7
# SPDX-FileCopyrightText: Copyright (C) 2024-2025 Tobias Schrödter
#
# SPDX-License-Identifier: MIT

"""Custom exception classes for PedPy.

This module defines a hierarchy of exceptions for clear and specific
Expand Down
5 changes: 5 additions & 0 deletions pedpy/internal/utils.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: Copyright (C) 2022-2025 Forschungszentrum Jülich GmbH, IAS-7
# SPDX-FileCopyrightText: Copyright (C) 2024-2025 Tobias Schrödter
#
# SPDX-License-Identifier: MIT

"""Module containing internal utilities."""

import functools
Expand Down
5 changes: 5 additions & 0 deletions pedpy/io/trajectory_loader.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: Copyright (C) 2022-2025 Forschungszentrum Jülich GmbH, IAS-7
# SPDX-FileCopyrightText: Copyright (C) 2024-2025 Tobias Schrödter
#
# SPDX-License-Identifier: MIT

"""Load trajectories to the internal trajectory data format."""

import math
Expand Down
5 changes: 5 additions & 0 deletions pedpy/methods/acceleration_calculator.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: Copyright (C) 2022-2025 Forschungszentrum Jülich GmbH, IAS-7
# SPDX-FileCopyrightText: Copyright (C) 2024-2025 Tobias Schrödter
#
# SPDX-License-Identifier: MIT

"""Module containing functions to compute accelerations."""

from typing import Optional, Tuple
Expand Down
5 changes: 5 additions & 0 deletions pedpy/methods/density_calculator.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: Copyright (C) 2022-2025 Forschungszentrum Jülich GmbH, IAS-7
# SPDX-FileCopyrightText: Copyright (C) 2024-2025 Tobias Schrödter
#
# SPDX-License-Identifier: MIT

"""Module containing functions to compute densities."""

from typing import Tuple
Expand Down
5 changes: 5 additions & 0 deletions pedpy/methods/flow_calculator.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: Copyright (C) 2022-2025 Forschungszentrum Jülich GmbH, IAS-7
# SPDX-FileCopyrightText: Copyright (C) 2024-2025 Tobias Schrödter
#
# SPDX-License-Identifier: MIT

"""Module containing functions to compute flows."""

from typing import Tuple
Expand Down
5 changes: 5 additions & 0 deletions pedpy/methods/method_utils.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: Copyright (C) 2022-2025 Forschungszentrum Jülich GmbH, IAS-7
# SPDX-FileCopyrightText: Copyright (C) 2024-2025 Tobias Schrödter
#
# SPDX-License-Identifier: MIT

"""Helper functions for the analysis methods."""

# pylint: disable=C0302
Expand Down
5 changes: 5 additions & 0 deletions pedpy/methods/profile_calculator.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: Copyright (C) 2022-2025 Forschungszentrum Jülich GmbH, IAS-7
# SPDX-FileCopyrightText: Copyright (C) 2024-2025 Tobias Schrödter
#
# SPDX-License-Identifier: MIT

"""Module containing functions to compute profiles.

For the computation of the profiles the given :class:`~geometry.WalkableArea`
Expand Down
5 changes: 5 additions & 0 deletions pedpy/methods/spatial_analysis.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: Copyright (C) 2022-2025 Forschungszentrum Jülich GmbH, IAS-7
# SPDX-FileCopyrightText: Copyright (C) 2024-2025 Tobias Schrödter
#
# SPDX-License-Identifier: MIT

"""Module containing functions to compute spatial analysis methods.

For example: the pair distribution function.
Expand Down
5 changes: 5 additions & 0 deletions pedpy/methods/speed_calculator.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: Copyright (C) 2022-2025 Forschungszentrum Jülich GmbH, IAS-7
# SPDX-FileCopyrightText: Copyright (C) 2024-2025 Tobias Schrödter
#
# SPDX-License-Identifier: MIT

"""Module containing functions to compute velocities."""

from typing import Optional, Tuple
Expand Down
5 changes: 5 additions & 0 deletions pedpy/plotting/plotting.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: Copyright (C) 2022-2025 Forschungszentrum Jülich GmbH, IAS-7
# SPDX-FileCopyrightText: Copyright (C) 2024-2025 Tobias Schrödter
#
# SPDX-License-Identifier: MIT

"""Module containing plotting functionalities."""

# pylint: disable=C0302
Expand Down
4 changes: 4 additions & 0 deletions tests/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# SPDX-FileCopyrightText: Copyright (C) 2022-2025 Forschungszentrum Jülich GmbH, IAS-7
# SPDX-FileCopyrightText: Copyright (C) 2024-2025 Tobias Schrödter
#
# SPDX-License-Identifier: MIT
5 changes: 5 additions & 0 deletions tests/reference_tests/reference_test.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: Copyright (C) 2022-2025 Forschungszentrum Jülich GmbH, IAS-7
# SPDX-FileCopyrightText: Copyright (C) 2024-2025 Tobias Schrödter
#
# SPDX-License-Identifier: MIT

import pathlib

import numpy as np
Expand Down
5 changes: 5 additions & 0 deletions tests/unit_tests/data/test_geometry.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: Copyright (C) 2022-2025 Forschungszentrum Jülich GmbH, IAS-7
# SPDX-FileCopyrightText: Copyright (C) 2024-2025 Tobias Schrödter
#
# SPDX-License-Identifier: MIT

import numpy as np
import pytest
import shapely
Expand Down
5 changes: 5 additions & 0 deletions tests/unit_tests/data/test_trajectory_data.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: Copyright (C) 2022-2025 Forschungszentrum Jülich GmbH, IAS-7
# SPDX-FileCopyrightText: Copyright (C) 2024-2025 Tobias Schrödter
#
# SPDX-License-Identifier: MIT

from dataclasses import FrozenInstanceError

import pandas as pd
Expand Down
5 changes: 5 additions & 0 deletions tests/unit_tests/io/test_trajectory_loader.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: Copyright (C) 2022-2025 Forschungszentrum Jülich GmbH, IAS-7
# SPDX-FileCopyrightText: Copyright (C) 2024-2025 Tobias Schrödter
#
# SPDX-License-Identifier: MIT

import pathlib
import re
import sqlite3
Expand Down
5 changes: 5 additions & 0 deletions tests/unit_tests/methods/test_density_calculator.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: Copyright (C) 2022-2025 Forschungszentrum Jülich GmbH, IAS-7
# SPDX-FileCopyrightText: Copyright (C) 2024-2025 Tobias Schrödter
#
# SPDX-License-Identifier: MIT

import numpy as np
import pandas as pd
import pytest
Expand Down
5 changes: 5 additions & 0 deletions tests/unit_tests/methods/test_flow_calculator.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: Copyright (C) 2022-2025 Forschungszentrum Jülich GmbH, IAS-7
# SPDX-FileCopyrightText: Copyright (C) 2024-2025 Tobias Schrödter
#
# SPDX-License-Identifier: MIT

import numpy as np
import pandas as pd
import pytest
Expand Down
5 changes: 5 additions & 0 deletions tests/unit_tests/methods/test_method_utils.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: Copyright (C) 2022-2025 Forschungszentrum Jülich GmbH, IAS-7
# SPDX-FileCopyrightText: Copyright (C) 2024-2025 Tobias Schrödter
#
# SPDX-License-Identifier: MIT

from unittest.mock import MagicMock

import numpy as np
Expand Down
5 changes: 5 additions & 0 deletions tests/unit_tests/methods/test_speed_calculator.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: Copyright (C) 2022-2025 Forschungszentrum Jülich GmbH, IAS-7
# SPDX-FileCopyrightText: Copyright (C) 2024-2025 Tobias Schrödter
#
# SPDX-License-Identifier: MIT

import numpy as np
import pandas as pd
import pytest
Expand Down
4 changes: 4 additions & 0 deletions tests/utils/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# SPDX-FileCopyrightText: Copyright (C) 2022-2025 Forschungszentrum Jülich GmbH, IAS-7
# SPDX-FileCopyrightText: Copyright (C) 2024-2025 Tobias Schrödter
#
# SPDX-License-Identifier: MIT
5 changes: 5 additions & 0 deletions tests/utils/utils.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: Copyright (C) 2022-2025 Forschungszentrum Jülich GmbH, IAS-7
# SPDX-FileCopyrightText: Copyright (C) 2024-2025 Tobias Schrödter
#
# SPDX-License-Identifier: MIT

from typing import List

import numpy as np
Expand Down
Loading