platerecipy 1.2.0__tar.gz

platerecipy-1.2.0/LICENSE

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

platerecipy-1.2.0/MANIFEST.in

@@ -0,0 +1,6 @@
+include src/clib/transform.c
+include src/clib/transform.h
+include src/clib/segmentation.c
+include src/clib/segmentation.h
+include LICENSE
+include pyproject.toml

platerecipy-1.2.0/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.4
+Name: platerecipy
+Version: 1.2.0
+Summary: PLATE RECognition In PYthon
+Home-page: https://github.com/pjavaheri/platerecipy
+Author: Pejvak Javaheri
+Author-email: pejvak.javaheri@mail.utoronto.ca
+License: MIT
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: matplotlib
+Requires-Dist: pyvista
+Requires-Dist: pandas
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
+
+platerecipy is a tool for detecting candidate plates on global geophysical datasets. It analyzes the surface to identify diffuse and non-conforming regions, as well as regions with low confidence in plate assignment.

platerecipy-1.2.0/README.md

@@ -0,0 +1,72 @@
+![logo](logo.png)
+
+# `platerecipy`: a package for PLATE RECognition In PYthon
+`platerecipy` is a tool for detecting candidate plates on global geophysical 
+datasets. It analyzes the surface to identify diffuse and non-conforming regions, 
+as well as regions with low confidence in plate assignment.
+
+## Supported platforms
+
+Though `platerecipy` is fundamentally a `Python` package, it also relies on 
+backend functionalities that are implemented in `C`. Typically, Windows compared 
+to Linux requires a slightly different compilation and linking which at this 
+stage is not supported. That is why, currently, Linux is the only supported platform.
+
+## Installation
+
+Releases are made available on PyPI so that `platerecipy` can be installed using 
+`pip` on the shell as follows:
+```bash
+python -m pip install platerecipy
+```
+
+## User guide
+
+`platerecipy`'s documentation is moved to [platerecipy.readthedocs.io](https://platerecipy.readthedocs.io/)!
+
+For a detailed explanation and illustration of `platerecipy`'s core functionalities,
+please refer to:
+> Javaheri, P., & Lowman, J. P. (2026). A random walker algorithm for plate boundary detection in spherical mantle convection models and global geophysical data sets: Application to Euler vector determination. _Journal of Geophysical Research: Solid Earth_, 131, e2025JB032259. https://doi.org/10.1029/2025JB032259
+
+As a demonstration, assuming a given `input_xs`, `input_ys`, `input_zs`, and  
+`input_field` (all `numpy` arrays), using `platerecipy` is as simple as follows:
+```python
+from platerecipy.model import PlateModel
+from platerecipy.grid import SphericalGrid
+
+input_xs    = # to be specified ...
+input_ys    = # to be specified ...
+input_zs    = # to be specified ...
+input_field = # to be specified ...
+
+# generating a consistent grid for interpolation
+grid = SphericalGrid(input_xs, input_ys, input_zs)
+
+# interpolating an input field
+field = grid.interpolate_field(input_field)
+
+# initializing a plate model
+m = PlateModel(grid)
+
+# stacking the interpolated field
+m.stack_field(field, take_log=True)
+
+# finding plates on the stacked field
+m.find_plates(
+    boundary_quantile     = 0.9,            # threshold for the boundaries 
+    separation_tolerance  = 4*3.1416/180.,  # 4 degrees for separation tolerance
+    RW_beta               = 200,            # RW beta (for feature sharpness)
+    min_marker_size       = 100             # to filter out micro plates
+)
+
+# outputting as a ParaView readable .vtp file
+from platerecipy import io
+io.save_as_vtp(m)
+```
+
+--------------------------------------------------------------------------------
+
+Developed by Pejvak Javaheri, 
+[pejvak.javaheri@mail.utoronto.ca](pejvak.javaheri@mail.utoronto.ca).
+
+

platerecipy-1.2.0/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"

platerecipy-1.2.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

platerecipy-1.2.0/setup.py

@@ -0,0 +1,52 @@
+from setuptools import setup, Extension, find_packages
+
+extra_compile_args=[
+    '-O3','-std=c99', '-fPIC', '-DLIBCTOOLS'
+]
+
+platerecipy_clib_transform_module = Extension(
+    'platerecipy_clib_transform',
+    sources = [
+        'src/clib/transform.c'
+    ],
+    include_dirs = ['src/clib'],
+    extra_compile_args=extra_compile_args,
+)
+
+platerecipy_clib_segmentation_module = Extension(
+    'platerecipy_clib_segmentation',
+    sources = [
+        'src/clib/segmentation.c'
+    ],
+    include_dirs = ['src/clib'],
+    extra_compile_args=extra_compile_args,
+)
+
+setup(
+    name = 'platerecipy',
+    version = '1.2.0',
+    description = 'PLATE RECognition In PYthon',
+    long_description = 
+        'platerecipy is a tool for detecting candidate plates on global geophysical ' 
+        'datasets. It analyzes the surface to identify diffuse and non-conforming regions, '
+        'as well as regions with low confidence in plate assignment.',
+    long_description_content_type = 'text/markdown',
+    url = 'https://github.com/pjavaheri/platerecipy',
+    author = 'Pejvak Javaheri',
+    author_email = 'pejvak.javaheri@mail.utoronto.ca',
+    license = 'MIT',
+    packages = find_packages(where='src', include=['platerecipy']),
+    package_dir = {'' : 'src'},
+    install_requires = [
+        'numpy', 
+        'scipy',
+        'matplotlib', 
+        'pyvista',
+        'pandas'
+    ],
+    ext_modules = [
+        platerecipy_clib_transform_module,
+        platerecipy_clib_segmentation_module
+    ],
+    zip_safe = False
+)