sandplover 0.5.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 The sandpiper-toolchain team
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,64 @@
1
+ Metadata-Version: 2.2
2
+ Name: sandplover
3
+ Version: 0.5.0
4
+ Summary: Tools for manipulating sedimentologic data cubes.
5
+ Author-email: Andrew Moodie <amoodie@tamu.edu>
6
+ Maintainer-email: Andrew Moodie <amoodie@tamu.edu>
7
+ License: MIT
8
+ Project-URL: documentation, https://sandpiper-toolchain.github.io/sandplover
9
+ Project-URL: homepage, https://github.com/sandpiper-toolchain/sandplover
10
+ Project-URL: repository, https://github.com/sandpiper-toolchain/sandplover
11
+ Classifier: Development Status :: 4 - Beta
12
+ Classifier: Intended Audience :: Science/Research
13
+ Classifier: License :: OSI Approved :: MIT License
14
+ Classifier: Operating System :: OS Independent
15
+ Classifier: Programming Language :: Python :: 3 :: Only
16
+ Classifier: Programming Language :: Python :: 3.11
17
+ Classifier: Programming Language :: Python :: 3.12
18
+ Classifier: Programming Language :: Python :: Implementation :: CPython
19
+ Classifier: Topic :: Scientific/Engineering :: Hydrology
20
+ Classifier: Topic :: Scientific/Engineering :: Physics
21
+ Requires-Python: >=3.11
22
+ Description-Content-Type: text/x-rst
23
+ License-File: LICENSE.txt
24
+ Requires-Dist: h5netcdf
25
+ Requires-Dist: h5py
26
+ Requires-Dist: importlib-resources; python_version < "3.12"
27
+ Requires-Dist: matplotlib
28
+ Requires-Dist: netCDF4
29
+ Requires-Dist: numba
30
+ Requires-Dist: numpy
31
+ Requires-Dist: pooch
32
+ Requires-Dist: pyyaml
33
+ Requires-Dist: scikit-image
34
+ Requires-Dist: scipy
35
+ Requires-Dist: xarray
36
+ Provides-Extra: docs
37
+ Requires-Dist: pyvista; extra == "docs"
38
+ Requires-Dist: sphinx; extra == "docs"
39
+ Provides-Extra: testing
40
+ Requires-Dist: coveralls; extra == "testing"
41
+ Requires-Dist: pytest; extra == "testing"
42
+ Requires-Dist: pytest-cov; extra == "testing"
43
+
44
+ **********
45
+ sandplover
46
+ **********
47
+
48
+ .. image:: https://github.com/sandpiper-toolchain/sandplover/actions/workflows/build.yml/badge.svg?branch=develop
49
+ :target: https://github.com/sandpiper-toolchain/sandplover/actions
50
+
51
+ .. image:: https://codecov.io/gh/sandpiper-toolchain/sandplover/branch/develop/graph/badge.svg
52
+ :target: https://codecov.io/gh/sandpiper-toolchain/sandplover
53
+
54
+ *sandplover* is a Python package for manipulating depositional system data cubes.
55
+ The package has robust objects and routines designed to help organize, visualize, and analyze topography and sedimentological timeseries data.
56
+ *sandplover* works especially well with data from deltaic systems (e.g., the `pyDeltaRCM numerical model <https://github.com/DeltaRCM/pyDeltaRCM>`_ and laboratory delta experiments).
57
+ This software was previously known as *DeltaMetrics*.
58
+
59
+ `Full documentation here <https://sandpiper-toolchain.github.io/sandplover/index.html>`_.
60
+
61
+
62
+ .. figure:: https://sandpiper-toolchain.github.io/sandplover/_images/cover.png
63
+
64
+ A view of bed elevation on a modeled deltaic deposit in ``Planform``, and a cross ``StrikeSection`` view of the timing of sediment deposition in stratigraphy.
@@ -0,0 +1,21 @@
1
+ **********
2
+ sandplover
3
+ **********
4
+
5
+ .. image:: https://github.com/sandpiper-toolchain/sandplover/actions/workflows/build.yml/badge.svg?branch=develop
6
+ :target: https://github.com/sandpiper-toolchain/sandplover/actions
7
+
8
+ .. image:: https://codecov.io/gh/sandpiper-toolchain/sandplover/branch/develop/graph/badge.svg
9
+ :target: https://codecov.io/gh/sandpiper-toolchain/sandplover
10
+
11
+ *sandplover* is a Python package for manipulating depositional system data cubes.
12
+ The package has robust objects and routines designed to help organize, visualize, and analyze topography and sedimentological timeseries data.
13
+ *sandplover* works especially well with data from deltaic systems (e.g., the `pyDeltaRCM numerical model <https://github.com/DeltaRCM/pyDeltaRCM>`_ and laboratory delta experiments).
14
+ This software was previously known as *DeltaMetrics*.
15
+
16
+ `Full documentation here <https://sandpiper-toolchain.github.io/sandplover/index.html>`_.
17
+
18
+
19
+ .. figure:: https://sandpiper-toolchain.github.io/sandplover/_images/cover.png
20
+
21
+ A view of bed elevation on a modeled deltaic deposit in ``Planform``, and a cross ``StrikeSection`` view of the timing of sediment deposition in stratigraphy.
@@ -0,0 +1,123 @@
1
+ [project]
2
+ name = "sandplover"
3
+ requires-python = ">=3.11"
4
+ description = "Tools for manipulating sedimentologic data cubes."
5
+ keywords = []
6
+ authors = [
7
+ { name = "Andrew Moodie", email = "amoodie@tamu.edu" },
8
+ ]
9
+ maintainers = [
10
+ { name = "Andrew Moodie", email = "amoodie@tamu.edu" },
11
+ ]
12
+ classifiers = [
13
+ "Development Status :: 4 - Beta",
14
+ "Intended Audience :: Science/Research",
15
+ "License :: OSI Approved :: MIT License",
16
+ "Operating System :: OS Independent",
17
+ "Programming Language :: Python :: 3 :: Only",
18
+ "Programming Language :: Python :: 3.11",
19
+ "Programming Language :: Python :: 3.12",
20
+ "Programming Language :: Python :: Implementation :: CPython",
21
+ "Topic :: Scientific/Engineering :: Hydrology",
22
+ "Topic :: Scientific/Engineering :: Physics",
23
+ ]
24
+ dependencies = [
25
+ "h5netcdf",
26
+ "h5py",
27
+ "importlib-resources; python_version < '3.12'",
28
+ "matplotlib",
29
+ "netCDF4",
30
+ "numba",
31
+ "numpy",
32
+ "pooch",
33
+ "pyyaml",
34
+ "scikit-image",
35
+ "scipy",
36
+ "xarray",
37
+ ]
38
+ dynamic = [
39
+ "version",
40
+ "readme",
41
+ ]
42
+
43
+ [project.license]
44
+ text = "MIT"
45
+
46
+ [project.urls]
47
+ documentation = "https://sandpiper-toolchain.github.io/sandplover"
48
+ homepage = "https://github.com/sandpiper-toolchain/sandplover"
49
+ repository = "https://github.com/sandpiper-toolchain/sandplover"
50
+
51
+ [project.optional-dependencies]
52
+ docs = [
53
+ "pyvista",
54
+ "sphinx",
55
+ ]
56
+ testing = [
57
+ "coveralls",
58
+ "pytest",
59
+ "pytest-cov",
60
+ ]
61
+
62
+ [build-system]
63
+ requires = [
64
+ "setuptools >=61",
65
+ ]
66
+ build-backend = "setuptools.build_meta"
67
+
68
+ [tool.isort]
69
+ combine_as_imports = true
70
+ known_first_party = "sandplover"
71
+ profile = "black"
72
+
73
+ [tool.setuptools]
74
+ include-package-data = true
75
+
76
+ [tool.setuptools.dynamic.readme]
77
+ file = "README.rst"
78
+ content-type = "text/x-rst"
79
+
80
+ [tool.setuptools.dynamic.version]
81
+ attr = "sandplover._version.__version__"
82
+
83
+ [tool.setuptools.package-data]
84
+ sandplover = [
85
+ "sample_data/registry.txt",
86
+ ]
87
+
88
+ [tool.setuptools.packages.find]
89
+ where = [
90
+ ".",
91
+ ]
92
+ include = [
93
+ "sandplover*",
94
+ ]
95
+
96
+ [tool.coverage.run]
97
+ relative_files = true
98
+
99
+ [tool.pytest.ini_options]
100
+ minversion = "6.0"
101
+ testpaths = [
102
+ "sandplover",
103
+ "tests",
104
+ ]
105
+ norecursedirs = [
106
+ ".*",
107
+ "*.egg*",
108
+ "build",
109
+ "dist",
110
+ ]
111
+ addopts = [
112
+ "--ignore=setup.py",
113
+ "--tb=native",
114
+ "--durations=16",
115
+ "--strict-markers",
116
+ "--doctest-modules",
117
+ "-vvv",
118
+ ]
119
+ doctest_optionflags = [
120
+ "NORMALIZE_WHITESPACE",
121
+ "IGNORE_EXCEPTION_DETAIL",
122
+ "ELLIPSIS",
123
+ ]
@@ -0,0 +1,4 @@
1
+ import sandplover.sample_data as sample_data
2
+ from sandplover._version import __version__
3
+
4
+ __all__ = ("sample_data", "__version__")
@@ -0,0 +1 @@
1
+ __version__ = "0.5.0"