hashpy 1.1.4.post1__tar.gz

hashpy-1.1.4.post1/.gitignore

@@ -0,0 +1,133 @@
+# 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
+*.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/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+#profile_default/
+#ipython_config.py
+
+# PEP 582
+__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/
+
+# Mac DS_Store
+.DS_Store
+
+# VSCode workspace
+*.code-workspace
+
+# Saved velocity models
+velocity_models/*.npz

hashpy-1.1.4.post1/CODE_OF_CONDUCT.md

@@ -0,0 +1,7 @@
+Code of Conduct
+===============
+
+All contributions to - and interactions surrounding - this project will abide by
+the [USGS Code of Scientific Conduct][1].
+
+[1]: https://www.usgs.gov/about/organization/science-support/science-quality-and-integrity/code-scientific-conduct

hashpy-1.1.4.post1/CONTRIBUTING.md

@@ -0,0 +1,16 @@
+Contributing
+============
+
+Contributions are welcome from the community. Questions can be asked on the
+[issues page][1]. Before creating a new issue, please take a moment to search
+and make sure a similar issue does not already exist. If one does exist, you
+can comment (most simply even with just a `:+1:`) to show your support for that
+issue.
+
+If you have direct contributions you would like considered for incorporation
+into the project you can [fork this repository][2] and
+[submit a pull request][3] for review.
+
+[1]: https://code.usgs.gov/esc/SKHASH/issues
+[2]: https://docs.gitlab.com/ee/user/project/repository/forking_workflow.html#create-a-fork
+[3]: https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html

hashpy-1.1.4.post1/CONTRIBUTORS.md

@@ -0,0 +1,12 @@
+# Contributors
+
+* Alicia Hotovec-Ellis
+
+### A special thanks to the following people for reporting bugs!
+
+* Armaan Bhargava-Shah
+* Alex Dzubay
+* Tomáš Fischer
+* Junhao Song
+
+(Did I forget to add you to the list? Let me know: rskoumal@usgs.gov)

hashpy-1.1.4.post1/DISCLAIMER.md

@@ -0,0 +1,11 @@
+Disclaimer
+==========
+
+This software is preliminary or provisional and is subject to revision. It is
+being provided to meet the need for timely best science. The software has not
+received final approval by the U.S. Geological Survey (USGS). No warranty,
+expressed or implied, is made by the USGS or the U.S. Government as to the
+functionality of the software and related material nor shall the fact of release
+constitute any such warranty. The software is provided on the condition that
+neither the USGS nor the U.S. Government shall be held liable for any damages
+resulting from the authorized or unauthorized use of the software.

hashpy-1.1.4.post1/LICENSE.md

@@ -0,0 +1,46 @@
+License
+=======
+
+Unless otherwise noted, This project is in the public domain in the United
+States because it contains materials that originally came from the United
+States Geological Survey, an agency of the United States Department of
+Interior. For more information, see the official USGS copyright policy at
+https://www.usgs.gov/information-policies-and-instructions/copyrights-and-credits
+
+Additionally, we waive copyright and related rights in the work
+worldwide through the CC0 1.0 Universal public domain dedication.
+
+
+CC0 1.0 Universal Summary
+-------------------------
+
+This is a human-readable summary of the
+[Legal Code (read the full text)][1].
+
+
+### No Copyright
+
+The person who associated a work with this deed has dedicated the work to
+the public domain by waiving all of his or her rights to the work worldwide
+under copyright law, including all related and neighboring rights, to the
+extent allowed by law.
+
+You can copy, modify, distribute and perform the work, even for commercial
+purposes, all without asking permission.
+
+
+### Other Information
+
+In no way are the patent or trademark rights of any person affected by CC0,
+nor are the rights that other persons may have in the work or in how the
+work is used, such as publicity or privacy rights.
+
+Unless expressly stated otherwise, the person who associated a work with
+this deed makes no warranties about the work, and disclaims liability for
+all uses of the work, to the fullest extent permitted by applicable law.
+When using or citing the work, you should not imply endorsement by the
+author or the affirmer.
+
+
+
+[1]: https://creativecommons.org/publicdomain/zero/1.0/legalcode

hashpy-1.1.4.post1/PKG-INFO

@@ -0,0 +1,116 @@
+Metadata-Version: 2.5
+Name: hashpy
+Version: 1.1.4.post1
+Summary: SKHASH (USGS) for earthquake focal mechanism inversions, packaged with NumPy 2 support
+Project-URL: Homepage, https://code.usgs.gov/esc/SKHASH
+Project-URL: Issues, https://code.usgs.gov/esc/SKHASH/-/issues
+Author-email: "Robert J. Skoumal" <rskoumal@usgs.gov>
+Maintainer: AI4EPS
+License-Expression: CC0-1.0
+License-File: LICENSE.md
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Requires-Dist: meson; python_version >= '3.12'
+Requires-Dist: ninja; python_version >= '3.12'
+Requires-Dist: numpy
+Requires-Dist: pandas
+Provides-Extra: plot
+Requires-Dist: matplotlib; extra == 'plot'
+Description-Content-Type: text/markdown
+
+# hashpy
+
+`hashpy` is [SKHASH](https://code.usgs.gov/esc/SKHASH) 1.1.4 by Robert J. Skoumal (U.S. Geological Survey), packaged unchanged except for NumPy 2 support (two lines: size-1 arrays to scalars in `mech_probability`, `np.isin` for `np.in1d`; the `numpy<2.0` pin lifted). All nine bundled examples give the same output under NumPy 1.26 and 2.x.
+
+```
+pip install hashpy
+hashpy path_to/control_file.txt
+```
+
+It imports as `hashpy`, so it does not clash with the official `SKHASH` package; use the original for anything else. Please cite Skoumal, Hardebeck & Shearer (2024). Public domain (CC0), as the original.
+
+---
+
+# SKHASH
+
+Python package for earthquake focal mechanism inversions.
+
+Author: Robert Skoumal, U.S. Geological Survey | rskoumal@usgs.gov
+
+This project contains Python code to compute focal mechanism solutions using first-motion polarities (traditional, consensus, and/or imputed) and S/P ratios (traditional and/or consensus).
+
+## How to Use
+#### 1. Install the latest release in your virtual environment:
+<pre>
+# If you <i><b>don't</b></i> want to create beachball plots:
+pip install -U SKHASH
+
+# If you <i><b>do</b></i> want to create beachball plots:
+pip install -U 'SKHASH[plot]'
+</pre>
+Python 3.8+ versions are supported.
+
+#### 2. Run SKHASH with your desired control file:
+```
+SKHASH path_to/control_file.txt
+```
+
+## More information
+### Running examples
+A variety of examples are provided in the repository. It's recommended you play around with these examples to learn about some of the features.
+1. Download the examples folder available [HERE](https://code.usgs.gov/esc/SKHASH/-/archive/main/SKHASH-main.zip?path=examples).
+2. Unzip the folder.
+3. Navigate to the examples folder you just downloaded, e.g.:
+`
+cd examples
+`
+4. Run SKHASH with the example of your choice, e.g.:
+`SKHASH hash1/control_file.txt`
+
+### Manual
+Refer to the [manual](https://code.usgs.gov/esc/SKHASH/-/blob/main/SKHASH_manual.pdf) or the [wiki](https://code.usgs.gov/esc/SKHASH/-/wikis/home) for additional information about running the code.
+
+## Fortran subroutine (completely optional)
+By default, SKHASH will compute mechanisms using the Python routine. However, to speed up the grid search, you can choose to take advantage of an included Fortran subroutine. If the Python C/API wrapper does not already exist, SKHASH will automatically create the wrapper with the user's permission when the Fortran subroutine is used.
+
+To use this Fortran routine, add the following lines to your control file:
+```
+$use_fortran
+True
+```
+
+A fortran compiler will be needed on the user's machine. If one does not exist, here are some examples on how to get one:
+```
+# macOS Homebrew example
+brew install gcc
+
+# Ubuntu example
+apt install gfortran
+```
+
+If you're using Python 3.12+, the [meson](https://pypi.org/project/meson-python) and [ninja](https://pypi.org/project/ninja) packages are also needed.
+```
+pip3 install meson ninja
+```
+
+Note that if you are using macOS and receive an error, you may be missing the Command Line Tools package. To install:
+```
+xcode-select --install
+```
+
+## Citation
+Please cite our paper if you use anything in this project:
+
+- Skoumal, R.J., Hardebeck, J.L., Shearer, P.M. (2024). SKHASH: A Python package for computing earthquake focal mechanisms. _Seismological Research Letters_, 95(4), 2519-2526. https://doi.org/10.1785/0220230329
+
+Significant portions of this algorithm are based on [HASH](https://www.usgs.gov/node/279393):
+
+- Hardebeck, J.L., & Shearer, P.M. (2002). A new method for determining first-motion focal mechanisms. _Bulletin of the Seismological Society of America_, 92(6), 2264-2276. https://doi.org/10.1785/0120010200
+
+- Hardebeck, J.L., & Shearer, P.M. (2003). Using S/P amplitude ratios to constrain the focal mechanisms of small earthquakes. _Bulletin of the Seismological Society of America_, 93(6), 2434-2444. https://doi.org/10.1785/0120020236
+
+## License and Disclaimer
+[License](https://code.usgs.gov/esc/SKHASH/-/blob/main/LICENSE.md): This project is in the public domain.
+
+[Disclaimer](https://code.usgs.gov/esc/SKHASH/-/blob/main/DISCLAIMER.md): This software is preliminary or provisional and is subject to revision.

hashpy-1.1.4.post1/README.md

@@ -0,0 +1,95 @@
+# hashpy
+
+`hashpy` is [SKHASH](https://code.usgs.gov/esc/SKHASH) 1.1.4 by Robert J. Skoumal (U.S. Geological Survey), packaged unchanged except for NumPy 2 support (two lines: size-1 arrays to scalars in `mech_probability`, `np.isin` for `np.in1d`; the `numpy<2.0` pin lifted). All nine bundled examples give the same output under NumPy 1.26 and 2.x.
+
+```
+pip install hashpy
+hashpy path_to/control_file.txt
+```
+
+It imports as `hashpy`, so it does not clash with the official `SKHASH` package; use the original for anything else. Please cite Skoumal, Hardebeck & Shearer (2024). Public domain (CC0), as the original.
+
+---
+
+# SKHASH
+
+Python package for earthquake focal mechanism inversions.
+
+Author: Robert Skoumal, U.S. Geological Survey | rskoumal@usgs.gov
+
+This project contains Python code to compute focal mechanism solutions using first-motion polarities (traditional, consensus, and/or imputed) and S/P ratios (traditional and/or consensus).
+
+## How to Use
+#### 1. Install the latest release in your virtual environment:
+<pre>
+# If you <i><b>don't</b></i> want to create beachball plots:
+pip install -U SKHASH
+
+# If you <i><b>do</b></i> want to create beachball plots:
+pip install -U 'SKHASH[plot]'
+</pre>
+Python 3.8+ versions are supported.
+
+#### 2. Run SKHASH with your desired control file:
+```
+SKHASH path_to/control_file.txt
+```
+
+## More information
+### Running examples
+A variety of examples are provided in the repository. It's recommended you play around with these examples to learn about some of the features.
+1. Download the examples folder available [HERE](https://code.usgs.gov/esc/SKHASH/-/archive/main/SKHASH-main.zip?path=examples).
+2. Unzip the folder.
+3. Navigate to the examples folder you just downloaded, e.g.:
+`
+cd examples
+`
+4. Run SKHASH with the example of your choice, e.g.:
+`SKHASH hash1/control_file.txt`
+
+### Manual
+Refer to the [manual](https://code.usgs.gov/esc/SKHASH/-/blob/main/SKHASH_manual.pdf) or the [wiki](https://code.usgs.gov/esc/SKHASH/-/wikis/home) for additional information about running the code.
+
+## Fortran subroutine (completely optional)
+By default, SKHASH will compute mechanisms using the Python routine. However, to speed up the grid search, you can choose to take advantage of an included Fortran subroutine. If the Python C/API wrapper does not already exist, SKHASH will automatically create the wrapper with the user's permission when the Fortran subroutine is used.
+
+To use this Fortran routine, add the following lines to your control file:
+```
+$use_fortran
+True
+```
+
+A fortran compiler will be needed on the user's machine. If one does not exist, here are some examples on how to get one:
+```
+# macOS Homebrew example
+brew install gcc
+
+# Ubuntu example
+apt install gfortran
+```
+
+If you're using Python 3.12+, the [meson](https://pypi.org/project/meson-python) and [ninja](https://pypi.org/project/ninja) packages are also needed.
+```
+pip3 install meson ninja
+```
+
+Note that if you are using macOS and receive an error, you may be missing the Command Line Tools package. To install:
+```
+xcode-select --install
+```
+
+## Citation
+Please cite our paper if you use anything in this project:
+
+- Skoumal, R.J., Hardebeck, J.L., Shearer, P.M. (2024). SKHASH: A Python package for computing earthquake focal mechanisms. _Seismological Research Letters_, 95(4), 2519-2526. https://doi.org/10.1785/0220230329
+
+Significant portions of this algorithm are based on [HASH](https://www.usgs.gov/node/279393):
+
+- Hardebeck, J.L., & Shearer, P.M. (2002). A new method for determining first-motion focal mechanisms. _Bulletin of the Seismological Society of America_, 92(6), 2264-2276. https://doi.org/10.1785/0120010200
+
+- Hardebeck, J.L., & Shearer, P.M. (2003). Using S/P amplitude ratios to constrain the focal mechanisms of small earthquakes. _Bulletin of the Seismological Society of America_, 93(6), 2434-2444. https://doi.org/10.1785/0120020236
+
+## License and Disclaimer
+[License](https://code.usgs.gov/esc/SKHASH/-/blob/main/LICENSE.md): This project is in the public domain.
+
+[Disclaimer](https://code.usgs.gov/esc/SKHASH/-/blob/main/DISCLAIMER.md): This software is preliminary or provisional and is subject to revision.

hashpy-1.1.4.post1/pyproject.toml

@@ -0,0 +1,49 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "hashpy"
+version = "1.1.4.post1"
+authors = [
+  { name="Robert J. Skoumal", email="rskoumal@usgs.gov" },
+]
+maintainers = [
+  { name="AI4EPS" },
+]
+description = "SKHASH (USGS) for earthquake focal mechanism inversions, packaged with NumPy 2 support"
+readme = "README.md"
+requires-python = ">=3.8"
+dependencies = [
+	"numpy",
+	"pandas",
+	"meson; python_version>='3.12'",
+	"ninja; python_version>='3.12'",
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+license = "CC0-1.0"
+license-files = ["LICENSE.md"]
+
+[project.optional-dependencies]
+plot=[
+	"matplotlib",
+]
+
+[tool.hatch.build]
+exclude = [
+	"examples",
+	"code.json",
+	"requirements.txt",
+	"*.pdf",
+	"*.so",
+]
+
+[project.scripts]
+hashpy = "hashpy.SKHASH:main"
+
+[project.urls]
+Homepage = "https://code.usgs.gov/esc/SKHASH"  # the original
+Issues = "https://code.usgs.gov/esc/SKHASH/-/issues"