pytheas_simulator 1.0.0__tar.gz

pytheas_simulator-1.0.0/.gitignore

@@ -0,0 +1,256 @@
+### caches and related
+.pytest_cache/
+*__pycache__/
+.ipynb_checkpoints/
+
+./configs
+
+testing_notebook.ipynb
+
+docs/build/
+
+### Linux template
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### Windows template
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+### JupyterNotebooks template
+# gitignore template for Jupyter Notebooks
+# website: http://jupyter.org/
+
+.ipynb_checkpoints
+*/.ipynb_checkpoints/*
+
+# IPython
+profile_default/
+ipython_config.py
+
+# Remove previous ipynb_checkpoints
+#   git rm -r .ipynb_checkpoints/
+
+### macOS template
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Python template
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+docs/api
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+
+# IPython
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Hatch-VCS
+_version.py

pytheas_simulator-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Matteo Tomasini
+
+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.

pytheas_simulator-1.0.0/PKG-INFO

@@ -0,0 +1,57 @@
+Metadata-Version: 2.5
+Name: pytheas_simulator
+Version: 1.0.0
+Summary: A pytheas package to simulate ancient seafaring.
+Project-URL: Homepage, https://github.com/mtomasini/PytheasSimulator
+Project-URL: Source Code, https://github.com/mtomasini/PytheasSimulator
+Project-URL: Bug Tracker, https://github.com/mtomasini/PytheasSimulator/issues
+Project-URL: Documentation, https://github.com/mtomasini/PytheasSimulator/blob/main/README.md
+Project-URL: Download, https://pypi.org/project/PytheasSimulator/#files
+Author: Matteo Tomasini
+License-Expression: MIT
+License-File: LICENSE
+Keywords: agent-based modelling,ancient navigation,ancient seafaring,bronze age,computational archaeology,neolithic
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.9
+Requires-Dist: bottleneck
+Requires-Dist: cartopy
+Requires-Dist: dask
+Requires-Dist: ephem>=4.2.1
+Requires-Dist: geopy>=2.3.0
+Requires-Dist: netcdf4
+Requires-Dist: numpy>=1.23.5
+Requires-Dist: opencv-python
+Requires-Dist: pandas>=1.5.3
+Requires-Dist: pip
+Requires-Dist: xarray==2023.1.0
+Requires-Dist: xoak
+Description-Content-Type: text/markdown
+
+# Pytheas - a flexible and agile simulator of ancient seafaring
+
+Current research in the [Maritime Encounters project](https://www.gu.se/en/research/maritime-encounters), at the University of Gothenburg, has been led by using and developing the software [Voyager](https://github.com/mtomasini/voyager). While this software is very complete and thorough, it can be difficult to maintain and develop due to the many components that it uses. I decided to write a version of the code that is more flexible and less complex to use, based on my own experiences in simulating seafaring in ancient times. This software is an improvement on the work by Alvaro Montenegro (Ohio State University) and Victor Wåhlstrand Skärström (University of Gothenburg, now at Chalmers University of Technology). The code is written in Python.
+
+At this stage, I only make available the code [and its documentation](https://mtomasini.github.io/pytheas-simulator/); at a latter stage, I will make available:
+
+- [ ] A demonstration file with attached parameters
+- [ ] A complete vignette containing a description of all functionalities
+- [ ] A script to download data from Copernicus for usage within Pytheas
+- [ ] (Optional) A snakemake file or similar that will help the user picking a few parameters and simulating with Pytheas without having to download data locally.
+
+## Development philosophy
+
+The code for Voyager was documented but had no tests. In the development of this new software, it is my intention to have even better documentation as well as unit testing. This follows from years of working in an academic context where tests are an afterthought and are seldom developed. But when using a software developed over years, by developers who have since quit the workplace, and that has required quick developments to respond to publication deadlines, the lack of testing in particular has proven deleterious, leading to bad mistakes at the production stage.
+
+## Name of the software
+
+I decided to name this new iteration of the Voyager software "Pytheas". As a software engineer, this is a (bad) pun on the fact that the software was developed in Python. But as an archaeologist, Pytheas was an ancient Greek navigator from Massalia (modern Marseille) who in around 330 BCE went on a sailing travel to the far North of Europe, reaching the British Isles and travelling further north to _Ultima Thule_ (which may be, according to Barry Cunliffe[^1], most probably Iceland, but possibly Norway or Shetland). Pytheas' travel has been source of inspiration and marvel for more than 2000 years.
+
+## License
+
+This software is packaged with a MIT License.
+
+[^1]: The Extraordinary Voyage of Pytheas the Greek, Barry Cunliffe (2001), Chapter 6.

pytheas_simulator-1.0.0/README.md

@@ -0,0 +1,24 @@
+# Pytheas - a flexible and agile simulator of ancient seafaring
+
+Current research in the [Maritime Encounters project](https://www.gu.se/en/research/maritime-encounters), at the University of Gothenburg, has been led by using and developing the software [Voyager](https://github.com/mtomasini/voyager). While this software is very complete and thorough, it can be difficult to maintain and develop due to the many components that it uses. I decided to write a version of the code that is more flexible and less complex to use, based on my own experiences in simulating seafaring in ancient times. This software is an improvement on the work by Alvaro Montenegro (Ohio State University) and Victor Wåhlstrand Skärström (University of Gothenburg, now at Chalmers University of Technology). The code is written in Python.
+
+At this stage, I only make available the code [and its documentation](https://mtomasini.github.io/pytheas-simulator/); at a latter stage, I will make available:
+
+- [ ] A demonstration file with attached parameters
+- [ ] A complete vignette containing a description of all functionalities
+- [ ] A script to download data from Copernicus for usage within Pytheas
+- [ ] (Optional) A snakemake file or similar that will help the user picking a few parameters and simulating with Pytheas without having to download data locally.
+
+## Development philosophy
+
+The code for Voyager was documented but had no tests. In the development of this new software, it is my intention to have even better documentation as well as unit testing. This follows from years of working in an academic context where tests are an afterthought and are seldom developed. But when using a software developed over years, by developers who have since quit the workplace, and that has required quick developments to respond to publication deadlines, the lack of testing in particular has proven deleterious, leading to bad mistakes at the production stage.
+
+## Name of the software
+
+I decided to name this new iteration of the Voyager software "Pytheas". As a software engineer, this is a (bad) pun on the fact that the software was developed in Python. But as an archaeologist, Pytheas was an ancient Greek navigator from Massalia (modern Marseille) who in around 330 BCE went on a sailing travel to the far North of Europe, reaching the British Isles and travelling further north to _Ultima Thule_ (which may be, according to Barry Cunliffe[^1], most probably Iceland, but possibly Norway or Shetland). Pytheas' travel has been source of inspiration and marvel for more than 2000 years.
+
+## License
+
+This software is packaged with a MIT License.
+
+[^1]: The Extraordinary Voyage of Pytheas the Greek, Barry Cunliffe (2001), Chapter 6.

pytheas_simulator-1.0.0/pyproject.toml

@@ -0,0 +1,208 @@
+################################################################################
+# Build Configuration
+################################################################################
+
+[build-system]
+build-backend = "hatchling.build"
+requires = ["hatchling"]
+
+################################################################################
+# Project Configuration
+################################################################################
+
+[project]
+name = "pytheas_simulator"
+# You can chose to use dynamic versioning with hatch or static where you add it manually.
+version = "1.0.0"
+
+description = "A pytheas package to simulate ancient seafaring."
+authors = [
+    { name = "Matteo Tomasini" },
+]
+license = "MIT"
+requires-python = ">= 3.9" # Adjust based on the minimum version of Python that you support
+readme = {"file" = "README.md", "content-type" = "text/markdown"}
+# Please consult https://pypi.org/classifiers/ for a full list.
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3 :: Only",
+]
+keywords = [
+    "ancient seafaring",
+    "ancient navigation",
+    "bronze age",
+    "neolithic",
+    "computational archaeology",
+    "agent-based modelling"
+]
+dependencies = [
+    "bottleneck",
+    "cartopy",
+    "dask",
+    "ephem>=4.2.1",
+    "geopy>=2.3.0",
+    "netCDF4",
+    "numpy>=1.23.5",
+    "opencv-python",
+    "pandas>=1.5.3",
+    "pip",
+    "xarray==2023.1.0",
+    "xoak"
+]
+
+[project.urls]
+Homepage = "https://github.com/mtomasini/PytheasSimulator"
+"Source Code" = "https://github.com/mtomasini/PytheasSimulator"
+"Bug Tracker" = "https://github.com/mtomasini/PytheasSimulator/issues"
+Documentation = "https://github.com/mtomasini/PytheasSimulator/blob/main/README.md"
+# Note: update this url when you have published your package to pypi. (or delete it)
+Download = "https://pypi.org/project/PytheasSimulator/#files"
+
+[dependency-groups]
+dev = [
+    "hatch",
+    "pre-commit",
+    "bottleneck",
+    "cartopy",
+    "dask",
+    "ephem>=4.2.1",
+    "geopy>=2.3.0",
+    "netCDF4",
+    "numpy>=1.23.5",
+    "opencv-python",
+    "pandas>=1.5.3",
+    "pip",
+    "xarray==2023.1.0",
+    "xoak"
+]
+
+docs = [
+    "sphinx~=8.0",
+    "myst-parser>=4.0",
+    "pydata-sphinx-theme>=0.16",
+    "sphinx-autobuild>=2024.10.3",
+    "sphinx-autoapi>=3.6.0",
+    "sphinx-copybutton>=0.5.2",
+    "sphinx-design>=0.6.1",
+]
+
+build = [
+    "pip-audit",
+    "twine",
+]
+tests = [
+    "pytest",
+    "pytest-cov",
+]
+
+
+################################################################################
+# Tool Configuration
+################################################################################
+
+# Hatch is building your package's wheel and sdist
+# This tells hatch to only include Python packages (i.e., folders with __init__.py) in the build.
+# read more about package building, here:
+# https://www.pyopensci.org/python-package-guide/package-structure-code/python-package-distribution-files-sdist-wheel.html
+[tool.hatch.build]
+only-packages = true
+
+# This tells Hatch to build the package from the src/ directory.
+# Read more about src layouts here: https://www.pyopensci.org/python-package-guide/package-structure-code/python-package-structure.html
+[tool.hatch.build.targets.wheel]
+packages = ["src/pytheastest"]
+
+
+
+######## Configure pytest for your test suite ########
+[tool.pytest.ini_options]
+testpaths = ["tests"] # Tells pytest what directory tests are in
+markers = ["raises"] # Tells pytest to not raise a warning if you use @pytest.mark.raises
+
+[tool.coverage.paths]
+source = [
+    "src/pytheas_simulator",
+    "*/site-packages/pytheas_simulator",
+]
+
+[tool.coverage.run]
+# Ensures code coverage is measured for branches (conditional statements with different outcomes) in your code.
+branch = true
+parallel = true
+
+[tool.coverage.report]
+# This configures the output test coverage report
+exclude_lines = ["pragma: no cover"]
+precision = 2
+
+
+# Use UV to create Hatch environments
+[tool.hatch.envs.default]
+installer = "uv"
+
+################################################################################
+# Hatch Environments
+################################################################################
+
+#--------------- Build and check your package ---------------#
+
+# This table installs the tools you need to test and build your package
+[tool.hatch.envs.build]
+description = """Test the installation the package."""
+dependency-groups = [
+    "build",
+]
+builder = true
+
+# This table installs created the command hatch run install:check which will build and check your package.
+[tool.hatch.envs.build.scripts]
+check = [
+    "hatch build {args:--clean}",
+    "twine check dist/*",
+]
+
+#--------------- Run tests ---------------#
+[tool.hatch.envs.test]
+description = """Run the test suite."""
+dependency-groups = [
+  "tests",
+]
+
+[[tool.hatch.envs.test.matrix]]
+python = ["3.11", "3.12", "3.13"]
+
+[tool.hatch.envs.test.scripts]
+run = "pytest {args:--cov=pytheastest --cov-report=term-missing --cov-report=xml}"
+
+#--------------- Build and preview your documentation ---------------#
+
+# This sets up a hatch environment with associated dependencies that need to be installed
+[tool.hatch.envs.docs]
+description = """Build or serve the documentation."""
+# Install optional dependency test for docs
+dependency-groups = [
+    "docs",
+]
+
+# This table contains the scripts that you can use to build and serve your docs
+# hatch run docs:build will build your documentation
+# hatch run docs:serve will serve them 'live' on your computer locally
+[tool.hatch.envs.docs.scripts]
+build = ["sphinx-build {args:-W -b html docs docs/_build}"]
+serve = ["sphinx-autobuild docs --watch src/pytheastest {args:-b html docs/_build/serve}"]
+
+
+
+#--------------- Check security for your dependencies ---------------#
+
+[tool.hatch.envs.audit]
+description = """Check dependencies for security vulnerabilities."""
+dependency-groups = [
+    "build",
+]
+
+[tool.hatch.envs.audit.scripts]
+check = ["pip-audit"]