Stripy
Stripy: A Python module for (constrained) triangulation in Cartesian coordinates and on a sphere. - Published in JOSS (2019)
Science Score: 95.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 9 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org -
✓Committers with academic emails
3 of 17 committers (17.6%) from academic institutions -
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Keywords
Keywords from Contributors
Scientific Fields
Repository
2D spherical and Cartesian triangulation toolkit using tripack, stripack, srfpack and ssrfpack
Basic Info
- Host: GitHub
- Owner: underworldcode
- License: lgpl-3.0
- Language: Jupyter Notebook
- Default Branch: master
- Homepage: https://underworldcode.github.io/stripy/2.0.5b2_api
- Size: 317 MB
Statistics
- Stars: 56
- Watchers: 5
- Forks: 13
- Open Issues: 9
- Releases: 21
Topics
Metadata Files
README.md
Stripy
A Python interface to TRIPACK and STRIPACK Fortran code for (constrained) triangulation in Cartesian coordinates and on a sphere. Stripy is an object-oriented package and includes routines from SRFPACK and SSRFPACK for interpolation (nearest neighbor, linear and hermite cubic) and to evaluate derivatives (Renka 1996a,b and 1997a,b).
stripy is bundled with litho1pt0 which is a python interface to the crust 1.0 dataset and the lithospheric part of the litho 1.0 dataset (Laske et al, 2013 and Pasyanos et al, 2014) which both requires and demonstrates the triangulation / searching and interpolation on the sphere that is provided by stripy.
Sample images created with stripy illustrating the meshing capability: ocean age data can be triangulated on the sphere with no need for points on land. Once stripy ingests your data points, you can sample another dataset to your grid (bathymetry on the right), smooth, find the derivatives of your data, or interpolate to another set of points.
Documentation
There are two matching sets of stripy notebooks - one set for Cartesian Triangulations and one for Spherical Triangulations. For most geographical applications, the spherical triangulations are the natural choice as they expect longitude and latitude coordinates (admittedly in radians). There are some worked examples
which use the companion package litho1pt0
Stable code
- Documentation / Notebooks https://underworldcode.github.io/stripy/2.0.5b2
- API documentation https://underworldcode.github.io/stripy/2.0.5b2_api
Bleeding edge code
- Documentation / Notebooks https://underworldcode.github.io/stripy/2.1.0b1
- API documentation https://underworldcode.github.io/stripy/2.1.0b1_api
For previous versions, see the changelog
Installation & Running in the cloud
Binder
Launch the demonstration <!-- at links.underworldcode.org/stripy-live (mybinder.org) -->
(This is the development branch)
Citation
Moresi, L. and Mather, B.R., (2019). Stripy: A Python module for (constrained) triangulation in Cartesian coordinates and on a sphere.. Journal of Open Source Software, 4(38), 1410, https://doi.org/10.21105/joss.01410
Navigation / Notebooks
There are two matching sets of stripy notebooks - one set for Cartesian Triangulations and one for Spherical Triangulations. For most geographical applications, the spherical triangulations are the natural choice as they expect longitude and latitude coordinates (admittedly in radians).
Note: the Cartesian and Spherical notebooks can be obtained / installed from stripy itself as follows:
bash
python -c 'import stripy; stripy.documentation.install_documentation(path="Notebooks")'
Cartesian
- Ex1-Cartesian-Triangulations.ipynb
- Ex2-CartesianGrids.ipynb
- Ex3-Interpolation.ipynb
- Ex4-Gradients.ipynb
- Ex5-Smoothing.ipynb
- Ex6-Scattered-Data.ipynb
- Ex7-Refinement-of-Triangulations.ipynb
- Ex8-Spline-Tension.ipynb
- Ex9-Voronoi-Diagram.ipynb
Spherical
- Ex1-Spherical-Triangulations.ipynb
- Ex2-SphericalGrids.ipynb
- Ex3-Interpolation.ipynb
- Ex4-Gradients.ipynb
- Ex5-Smoothing.ipynb
- Ex6-Scattered-Data.ipynb
- Ex7-Refinement-of-Triangulations.ipynb
- Ex8-Spline-Tension.ipynb
- Ex9-Voronoi-Diagram.ipynb
Examples
Note, these examples are the notebooks from litho1pt0 which are installed from the
package itself:
bash
python -c 'import litho1pt0; litho1pt0.documentation.install_documentation(path="Notebooks")'
The first three notebooks are an introduction to litho1pt0 that does not explicitly mention stripy but
the next two worked examples show how to search, interpolate and plot with the help of stripy routines.
- Ex1-Litho1Layers.ipynb
- Ex2-Litho1Properties.ipynb
- Ex3-CrustalRegionalisation.ipynb
- WorkEx1-CratonAverageProperties.ipynb
- WorkEx2-OceanDepthAge.ipynb
Installation
Dependencies
You will need Python 3.6+. Also, the following packages are required:
Recommended Packages for running the notebooks:
All of which should be available from pip or anaconda (conda-forge) for most platforms.
Installing using pip
You can install stripy using the
pip package manager with either version of Python:
bash
python3 -m pip install stripy
All the dependencies will be automatically installed by pip, except for gfortran
(or any Fortran compiler). It must be installed in your system before installing
stripy with pip.
If you change the Fortran compiler, you may have to add the
flags config_fc --fcompiler=<compiler name> when setup.py is run
(see docs for numpy.distutils).
Installing with conda
If you use the anaconda packaging system, then you should be able to
bash
conda install -c geo-down-under stripy
Usage
Two classes are included as part of the Stripy package:
sTriangulation(Spherical coordinates)Triangulation(Cartesian coordinates)
These classes share similar methods and can be easily interchanged. In addition, there are many helper functions provided for building meshes.
A series of tests are located in the tests subdirectory.
In order to perform these tests clone the repository and run pytest:
bash
git checkout https://github.com/underworldcode/stripy.git
cd stripy
pytest -v
References
Laske, G., G. Masters, and Z. Ma (2013), Update on CRUST1. 0—A 1-degree global model of Earth's crust, Geophys Research Abstracts, 15, EGU2013–2658.
Pasyanos, M. E., T. G. Masters, G. Laske, and Z. Ma (2014), LITHO1.0: An updated crust and lithospheric model of the Earth, Journal of Geophysical Research-Solid Earth, 119(3), 2153–2173, doi:10.1002/2013JB010626.
R. J. Renka, "ALGORITHM 751: TRIPACK: A Constrained Two- Dimensional Delaunay Triangulation Package" ACM Trans. Math. Software, Vol. 22, No. 1, 1996, pp. 1-8.
R. J. Renka, "ALGORITHM 752: SRFPACK: Software for Scattered Data Fitting with a Constrained Surface under Tension", ACM Trans. Math. Software, Vol. 22, No. 1, 1996, pp. 9-17.
R. J. Renka, "ALGORITHM 772: STRIPACK: Delaunay Triangulation and Voronoi Diagram on the Surface of a Sphere" ACM Trans. Math. Software, Vol. 23, No. 3, 1997, pp. 416-434.
R. J. Renka, "ALGORITHM 773: SSRFPACK: Interpolation of Scattered Data on the Surface of a Sphere with a Surface under Tension", ACM Trans. Math. Software, Vol. 23, No. 3, 1997, pp. 437-439.
Owner
- Name: Underworld geodynamics software platform and tools
- Login: underworldcode
- Kind: organization
- Email: help@underworldcode.org
- Website: http://www.underworldcode.org
- Twitter: underworldcode
- Repositories: 24
- Profile: https://github.com/underworldcode
Computational tools for the geodynamics community. Built in Australia, used all over (and under) the world. For support / help visit @underworld-community
JOSS Publication
Stripy: A Python module for (constrained) triangulation in Cartesian coordinates and on a sphere.
Authors
School of Earth Science, The University of Melbourne, Research School of Earth Sciences, Australian National University
School of Geoscience, The University of Sydney
Editor
Viviane Pons
Tags
triangulation splines interpolation spherical mesh Cartesian meshGitHub Events
Total
- Issues event: 3
- Watch event: 2
- Issue comment event: 13
- Push event: 4
Last Year
- Issues event: 3
- Watch event: 2
- Issue comment event: 13
- Push event: 4
Committers
Last synced: 5 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| lmoresi | 183 | |
| lmoresi | l****i | 169 |
| Ben Mather | b****1@g****m | 156 |
| gbullock | g****g@n****m | 15 |
| Ben Mather | a****t@i****m | 6 |
| Joseph Curtis | j****s@l****v | 6 |
| Romain Beucher | r****r@t****r | 5 |
| Romain Beucher | r****r@a****u | 4 |
| Chris Alfonso | c****o@s****u | 4 |
| Ben Mather | b****r@c****e | 4 |
| Santiago Soler | s****r@g****m | 3 |
| Julian Giordani | j****b | 3 |
| Louis Moresi | l****i@v****l | 3 |
| Arfon Smith | a****n | 1 |
| Marco Fusè | f****o@g****m | 1 |
| kwagstyl | k****l@g****m | 1 |
| dependabot[bot] | 4****] | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 4 months ago
All Time
- Total issues: 48
- Total pull requests: 59
- Average time to close issues: about 1 month
- Average time to close pull requests: 16 days
- Total issue authors: 22
- Total pull request authors: 12
- Average comments per issue: 4.77
- Average comments per pull request: 1.07
- Merged pull requests: 53
- Bot issues: 0
- Bot pull requests: 1
Past Year
- Issues: 3
- Pull requests: 1
- Average time to close issues: N/A
- Average time to close pull requests: 9 days
- Issue authors: 2
- Pull request authors: 1
- Average comments per issue: 4.67
- Average comments per pull request: 0.0
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 1
Top Authors
Issue Authors
- santisoler (13)
- lmoresi (7)
- brmather (4)
- jccurtis (3)
- bamartin125 (2)
- jcannon-gplates (2)
- rrenka (2)
- NengLu (1)
- rmmilewi (1)
- kwagstyl (1)
- jimc101 (1)
- wordsworthgroup (1)
- j-seuren (1)
- rbeucher (1)
- anowacki (1)
Pull Request Authors
- lmoresi (22)
- brmather (14)
- sound-fx (9)
- jccurtis (3)
- santisoler (3)
- rbeucher (2)
- dependabot[bot] (2)
- ledragna (1)
- julesghub (1)
- kwagstyl (1)
- arfon (1)
- cpalfonso (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 2
-
Total downloads:
- pypi 2,794 last-month
- Total docker downloads: 120
-
Total dependent packages: 4
(may contain duplicates) -
Total dependent repositories: 6
(may contain duplicates) - Total versions: 34
- Total maintainers: 3
pypi.org: stripy
Python interface to TRIPACK and STRIPACK fortran code for triangulation/interpolation in Cartesian coordinates and on a sphere
- Homepage: https://github.com/underworldcode/stripy
- Documentation: https://stripy.readthedocs.io/
- License: GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU General Public License. "The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the "Linked Version". The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library.
-
Latest release: 2.3.3
published about 2 years ago
Rankings
conda-forge.org: stripy
- Homepage: https://github.com/underworldcode/stripy
- License: LGPL-2.0-or-later
-
Latest release: 2.1.2
published over 3 years ago
Rankings
Dependencies
- numpy >=1.16.0
- scipy >=1.0.0
- RalfG/python-wheels-manylinux-build v0.4.2-manylinux2014_x86_64 composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
- actions/setup-python v1 composite
- conda-incubator/setup-miniconda v2 composite
- actions/cache v1 composite
- actions/checkout v2 composite
- conda-incubator/setup-miniconda v2 composite
- peaceiris/actions-gh-pages v3 composite
- actions/cache v1 composite
- actions/checkout v2 composite
- conda-incubator/setup-miniconda v2 composite
- peaceiris/actions-gh-pages v3 composite
- ${FROMIMG_ARG} latest build