gprm 0.1.0__tar.gz

gprm-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Simon Williams
+
+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.

gprm-0.1.0/MANIFEST.in

@@ -0,0 +1,2 @@
+recursive-include gprm/Data *
+include LICENSE README.md

gprm-0.1.0/PKG-INFO

@@ -0,0 +1,116 @@
+Metadata-Version: 2.4
+Name: gprm
+Version: 0.1.0
+Summary: Tools for building and working with GPlates plate tectonic reconstruction models
+Author-email: Simon Williams <siwill22@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/siwill22/GPlatesReconstructionModel
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: pandas
+Requires-Dist: geopandas
+Requires-Dist: shapely
+Requires-Dist: matplotlib
+Requires-Dist: xarray
+Requires-Dist: pygplates
+Requires-Dist: PlateTectonicTools
+Requires-Dist: pooch
+Requires-Dist: rasterio
+Requires-Dist: requests
+Requires-Dist: tqdm
+Requires-Dist: pyyaml
+Requires-Dist: setuptools<80
+Requires-Dist: cartopy
+Provides-Extra: viz
+Requires-Dist: pygmt; extra == "viz"
+Provides-Extra: geophysics
+Requires-Dist: pyshtools; extra == "geophysics"
+Requires-Dist: litho1pt0; extra == "geophysics"
+Requires-Dist: pmagpy; extra == "geophysics"
+Provides-Extra: spatial
+Requires-Dist: stripy; extra == "spatial"
+Requires-Dist: astropy-healpix; extra == "spatial"
+Requires-Dist: scikit-image; extra == "spatial"
+Requires-Dist: scikit-learn; extra == "spatial"
+Provides-Extra: all
+Requires-Dist: gprm[geophysics,spatial,viz]; extra == "all"
+Dynamic: license-file
+
+# GPlatesReconstructionModel
+
+*Prototyping for GPlates plate reconstructions as a python class*
+
+- Usage examples are available in the test_notebooks directory
+
+## Installation
+
+Install directly from GitHub with pip:
+```
+pip install git+https://github.com/siwill22/GPlatesReconstructionModel
+```
+
+This pulls in every core dependency automatically, including `pygplates` and
+`PlateTectonicTools`, both of which are ordinary PyPI packages.
+
+To also install the optional dependencies for plotting, geophysics helpers, and additional
+spatial algorithms, install the `all` extra:
+```
+pip install "gprm[all] @ git+https://github.com/siwill22/GPlatesReconstructionModel"
+```
+
+A plain install needs **no system packages** — every core dependency has wheels on PyPI for
+Linux, macOS and Windows. That means the data-preparation and analysis path (fetching
+reconstruction models, assigning plate IDs, reconstructing data, plate snapshots, and all
+proximity calculations) runs on a headless machine or in CI with nothing but `pip install`.
+
+`pygmt` is deliberately **not** a core dependency, because it is a wrapper around the GMT
+command-line library and does not bundle GMT itself — that is the one thing pip cannot
+install for you. It is only needed for plotting and for a few grid-sampling helpers, all of
+which import it at the point of use and tell you what to install if it is missing.
+
+## Python Dependencies
+### Required (installed automatically, all pip-installable):
+- numpy, scipy, pandas
+- geopandas, shapely, rasterio
+- matplotlib, xarray, cartopy
+- pygplates
+- PlateTectonicTools (https://github.com/EarthByte/PlateTectonicTools) — this itself
+  imports `cartopy` unconditionally, which is why `cartopy` is required rather than optional
+- pooch, requests, tqdm, pyyaml
+
+### Optional extras:
+- `pip install "gprm[viz]"` — pygmt (plotting, grid sampling). **pygmt also needs GMT >=6
+  installed separately**: `conda install -c conda-forge gmt`, Homebrew's `gmt`, or your Linux
+  package manager.
+- `pip install "gprm[geophysics]"` — pyshtools, litho1pt0, pmagpy
+- `pip install "gprm[spatial]"` — stripy, astropy-healpix, scikit-image, scikit-learn
+  (if astropy-healpix is not installed, some functions fall back on precomputed point
+  distributions in the `Data` folder)
+- `pip install "gprm[all]"` — everything above
+
+### Where downloaded data goes
+Datasets are cached with `pooch`, in a platform-dependent location. Ask for it rather than
+writing it out by hand:
+```python
+from gprm.datasets import cache_path
+cache_path()                                    # the cache root
+cache_path('TorsvikCocks2017', 'CEED6_LAND.gpml')  # a file inside a fetched bundle
+```
+
+**Note on `stripy`**: `stripy` (pulled in directly by `spatial`, and transitively by
+`geophysics` via `litho1pt0`) has no prebuilt wheel for Apple Silicon macOS on any Python
+version, and none at all for Python 3.13+. On those platforms pip will try to build it from
+source, which needs a Fortran compiler (e.g. `brew install gcc` on macOS, or
+`conda install -c conda-forge stripy` as an alternative to pip for just that package).
+
+

gprm-0.1.0/README.md

@@ -0,0 +1,68 @@
+# GPlatesReconstructionModel
+
+*Prototyping for GPlates plate reconstructions as a python class*
+
+- Usage examples are available in the test_notebooks directory
+
+## Installation
+
+Install directly from GitHub with pip:
+```
+pip install git+https://github.com/siwill22/GPlatesReconstructionModel
+```
+
+This pulls in every core dependency automatically, including `pygplates` and
+`PlateTectonicTools`, both of which are ordinary PyPI packages.
+
+To also install the optional dependencies for plotting, geophysics helpers, and additional
+spatial algorithms, install the `all` extra:
+```
+pip install "gprm[all] @ git+https://github.com/siwill22/GPlatesReconstructionModel"
+```
+
+A plain install needs **no system packages** — every core dependency has wheels on PyPI for
+Linux, macOS and Windows. That means the data-preparation and analysis path (fetching
+reconstruction models, assigning plate IDs, reconstructing data, plate snapshots, and all
+proximity calculations) runs on a headless machine or in CI with nothing but `pip install`.
+
+`pygmt` is deliberately **not** a core dependency, because it is a wrapper around the GMT
+command-line library and does not bundle GMT itself — that is the one thing pip cannot
+install for you. It is only needed for plotting and for a few grid-sampling helpers, all of
+which import it at the point of use and tell you what to install if it is missing.
+
+## Python Dependencies
+### Required (installed automatically, all pip-installable):
+- numpy, scipy, pandas
+- geopandas, shapely, rasterio
+- matplotlib, xarray, cartopy
+- pygplates
+- PlateTectonicTools (https://github.com/EarthByte/PlateTectonicTools) — this itself
+  imports `cartopy` unconditionally, which is why `cartopy` is required rather than optional
+- pooch, requests, tqdm, pyyaml
+
+### Optional extras:
+- `pip install "gprm[viz]"` — pygmt (plotting, grid sampling). **pygmt also needs GMT >=6
+  installed separately**: `conda install -c conda-forge gmt`, Homebrew's `gmt`, or your Linux
+  package manager.
+- `pip install "gprm[geophysics]"` — pyshtools, litho1pt0, pmagpy
+- `pip install "gprm[spatial]"` — stripy, astropy-healpix, scikit-image, scikit-learn
+  (if astropy-healpix is not installed, some functions fall back on precomputed point
+  distributions in the `Data` folder)
+- `pip install "gprm[all]"` — everything above
+
+### Where downloaded data goes
+Datasets are cached with `pooch`, in a platform-dependent location. Ask for it rather than
+writing it out by hand:
+```python
+from gprm.datasets import cache_path
+cache_path()                                    # the cache root
+cache_path('TorsvikCocks2017', 'CEED6_LAND.gpml')  # a file inside a fetched bundle
+```
+
+**Note on `stripy`**: `stripy` (pulled in directly by `spatial`, and transitively by
+`geophysics` via `litho1pt0`) has no prebuilt wheel for Apple Silicon macOS on any Python
+version, and none at all for Python 3.13+. On those platforms pip will try to build it from
+source, which needs a Fortran compiler (e.g. `brew install gcc` on macOS, or
+`conda install -c conda-forge stripy` as an alternative to pip for just that package).
+
+