dyncfs 1.0.0__tar.gz

dyncfs-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Zhou Jiangcheng
+
+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.

dyncfs-1.0.0/MANIFEST.in

@@ -0,0 +1,5 @@
+include README.md
+include LICENSE
+recursive-include fortran_src_codes *.f, *.h
+recursive-include dyncfs/exec *.jar
+recursive-include dyncfs *.py

dyncfs-1.0.0/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.4
+Name: dyncfs
+Version: 1.0.0
+Summary: A Python library for computing Coulomb Failure Stress Change.
+Home-page: https://github.com/Zhou-Jiangcheng/dyncfs
+Author: Zhou Jiangcheng
+Author-email: Zhou Jiangcheng <zhoujcpku@outlook.com>
+License: MIT License
+        
+        Copyright (c) 2024 Zhou Jiangcheng
+        
+        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.
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=2.3.3
+Requires-Dist: matplotlib>=3.9.2
+Requires-Dist: scipy>=1.16.2
+Requires-Dist: pandas>=2.2.3
+Requires-Dist: jpype1>=1.5.2
+Requires-Dist: tqdm>=4.67.1
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# Introduction
+
+This Python package serves as the frontend for calculating and building a Green's function library for synthetic seismograms and then compute the static/dynamic Coulomb Failure Stress Change. The backend consists of Wang Rongjiang's program for calculating synthetic seismograms, including EDGRN/EDCMP, [QSEIS_2006_STRESS](https://github.com/Zhou-Jiangcheng/QSEIS_2006_STRESS) and QSSP.  Traveling time is calculated using [TAUP](https://github.com/crotwell/TauP). Some geographic coordinate transformations use code from [obspy](https://github.com/obspy/obspy).
+
+References:
+Wang, R. (1999). A simple orthonormalization method for stable and efficient computation of Green’s functions.  *Bulletin of the Seismological Society of America* ,  *89* (3), 733–741. [https://doi.org/10.1785/BSSA0890030733](https://doi.org/10.1785/BSSA0890030733)
+
+Wang, R. (2003). Computation of deformation induced by earthquakes in a multi-layered elastic crust—FORTRAN programs EDGRN/EDCMP. Computers & Geosciences, 29(2), 195–207. https://doi.org/10.1016/S0098-3004(02)00111-5
+
+Wang, R., & Wang, H. (2007). A fast converging and anti-aliasing algorithm for green’s functions in terms of spherical or cylindrical harmonics. Geophysical Journal International, 170(1), 239–248. https://doi.org/10.1111/j.1365-246X.2007.03385.x
+
+Wang, R., Heimann, S., Zhang, Y., Wang, H., & Dahm, T. (2017). Complete synthetic seismograms based on a spherical self-gravitating earth model with an atmosphere–ocean–mantle–core structure. Geophysical Journal International, 210(3), 1739–1764. https://doi.org/10.1093/gji/ggx259
+
+# Installation
+
+1. Install the requirments by conda (conda 24.11.3)
+
+```
+conda create -n cfs python=3.11
+conda activate cfs
+conda install openjdk jpype1 gfortran numpy scipy pandas matplotlib tqdm -c conda-forge
+conda install geographiclib mpi4py -c conda-forge # optional
+```
+
+or install the requirments using system package manager, such as apt (Debian 12)
+
+```
+sudo apt install openjdk gfortran
+sudo apt install openmpi-common # optional
+```
+
+2. Download this reposity and install by pip.
+
+```
+git clone https://github.com/Zhou-Jiangcheng/dyncfs.git
+cd dyncfs
+pip install .
+```
+
+For code modification and debugging, use editable mode:
+
+```
+pip install -e .
+```
+
+or install from pypi
+
+```
+pip install dyncfs
+```
+
+# Usage
+
+Fill in all parameters in the .ini file, and prepare the input files as described in `example.ini`, including `source_plane[m].csv` and `obs_plane[n].csv` under the input directory, as well as `model.nd` representing the Earth model.
+
+1. Command-line usage
+
+```
+dyncfs --help
+```
+
+```
+usage: dyncfs [-h] --config CONFIG [--create-static-lib] [--compute-static-cfs] [--compute-static-cfs-fix-depth] [--run-static] [--create-dynamic-lib] [--compute-dynamic-cfs] [--compute-dynamic-cfs-fix-depth] [--run-dynamic] [--run-all]
+
+dyncfs command line tool
+
+options:
+  -h, --help            show this help message and exit
+  --config CONFIG       Path to the configuration file
+  --create-static-lib   Create static stress library
+  --compute-static-cfs  Compute static dCFS on obs faults
+  --compute-static-cfs-fix-depth
+                        Compute static dCFS at fixed depth
+  --run-static          Create static stress library and Compute static dCFS on obs faults and Compute static dCFS at fixed depth
+  --create-dynamic-lib  Create dynamic stress library
+  --compute-dynamic-cfs
+                        Compute dynamic dCFS on obs faults
+  --compute-dynamic-cfs-fix-depth
+                        Compute dynamic dCFS at fixed depth
+  --run-dynamic         Create dynamic stress library and Compute dynamic dCFS on obs faults and Compute dynamic dCFS at fixed depth
+  --run-all             Create static and dynamic stress library and Compute static and dynamic dCFS
+```
+
+2. Import and use classes and functions in .py files
+
+```
+from dyncfs.cfs_static import *
+
+if __name__ == "__main__":
+    config = CfsConfig()
+    config.read_config("example.ini")
+    create_static_lib(config)
+    compute_static_cfs_parallel(config)
+```
+
+```
+from dyncfs.cfs_dynamic import *
+
+if __name__ == "__main__":
+    config = CfsConfig()
+    config.read_config("example.ini")
+    create_dynamic_lib(config)
+    compute_dynamic_cfs_parallel(config)
+```

dyncfs-1.0.0/README.md

@@ -0,0 +1,104 @@
+# Introduction
+
+This Python package serves as the frontend for calculating and building a Green's function library for synthetic seismograms and then compute the static/dynamic Coulomb Failure Stress Change. The backend consists of Wang Rongjiang's program for calculating synthetic seismograms, including EDGRN/EDCMP, [QSEIS_2006_STRESS](https://github.com/Zhou-Jiangcheng/QSEIS_2006_STRESS) and QSSP.  Traveling time is calculated using [TAUP](https://github.com/crotwell/TauP). Some geographic coordinate transformations use code from [obspy](https://github.com/obspy/obspy).
+
+References:
+Wang, R. (1999). A simple orthonormalization method for stable and efficient computation of Green’s functions.  *Bulletin of the Seismological Society of America* ,  *89* (3), 733–741. [https://doi.org/10.1785/BSSA0890030733](https://doi.org/10.1785/BSSA0890030733)
+
+Wang, R. (2003). Computation of deformation induced by earthquakes in a multi-layered elastic crust—FORTRAN programs EDGRN/EDCMP. Computers & Geosciences, 29(2), 195–207. https://doi.org/10.1016/S0098-3004(02)00111-5
+
+Wang, R., & Wang, H. (2007). A fast converging and anti-aliasing algorithm for green’s functions in terms of spherical or cylindrical harmonics. Geophysical Journal International, 170(1), 239–248. https://doi.org/10.1111/j.1365-246X.2007.03385.x
+
+Wang, R., Heimann, S., Zhang, Y., Wang, H., & Dahm, T. (2017). Complete synthetic seismograms based on a spherical self-gravitating earth model with an atmosphere–ocean–mantle–core structure. Geophysical Journal International, 210(3), 1739–1764. https://doi.org/10.1093/gji/ggx259
+
+# Installation
+
+1. Install the requirments by conda (conda 24.11.3)
+
+```
+conda create -n cfs python=3.11
+conda activate cfs
+conda install openjdk jpype1 gfortran numpy scipy pandas matplotlib tqdm -c conda-forge
+conda install geographiclib mpi4py -c conda-forge # optional
+```
+
+or install the requirments using system package manager, such as apt (Debian 12)
+
+```
+sudo apt install openjdk gfortran
+sudo apt install openmpi-common # optional
+```
+
+2. Download this reposity and install by pip.
+
+```
+git clone https://github.com/Zhou-Jiangcheng/dyncfs.git
+cd dyncfs
+pip install .
+```
+
+For code modification and debugging, use editable mode:
+
+```
+pip install -e .
+```
+
+or install from pypi
+
+```
+pip install dyncfs
+```
+
+# Usage
+
+Fill in all parameters in the .ini file, and prepare the input files as described in `example.ini`, including `source_plane[m].csv` and `obs_plane[n].csv` under the input directory, as well as `model.nd` representing the Earth model.
+
+1. Command-line usage
+
+```
+dyncfs --help
+```
+
+```
+usage: dyncfs [-h] --config CONFIG [--create-static-lib] [--compute-static-cfs] [--compute-static-cfs-fix-depth] [--run-static] [--create-dynamic-lib] [--compute-dynamic-cfs] [--compute-dynamic-cfs-fix-depth] [--run-dynamic] [--run-all]
+
+dyncfs command line tool
+
+options:
+  -h, --help            show this help message and exit
+  --config CONFIG       Path to the configuration file
+  --create-static-lib   Create static stress library
+  --compute-static-cfs  Compute static dCFS on obs faults
+  --compute-static-cfs-fix-depth
+                        Compute static dCFS at fixed depth
+  --run-static          Create static stress library and Compute static dCFS on obs faults and Compute static dCFS at fixed depth
+  --create-dynamic-lib  Create dynamic stress library
+  --compute-dynamic-cfs
+                        Compute dynamic dCFS on obs faults
+  --compute-dynamic-cfs-fix-depth
+                        Compute dynamic dCFS at fixed depth
+  --run-dynamic         Create dynamic stress library and Compute dynamic dCFS on obs faults and Compute dynamic dCFS at fixed depth
+  --run-all             Create static and dynamic stress library and Compute static and dynamic dCFS
+```
+
+2. Import and use classes and functions in .py files
+
+```
+from dyncfs.cfs_static import *
+
+if __name__ == "__main__":
+    config = CfsConfig()
+    config.read_config("example.ini")
+    create_static_lib(config)
+    compute_static_cfs_parallel(config)
+```
+
+```
+from dyncfs.cfs_dynamic import *
+
+if __name__ == "__main__":
+    config = CfsConfig()
+    config.read_config("example.ini")
+    create_dynamic_lib(config)
+    compute_dynamic_cfs_parallel(config)
+```

dyncfs-1.0.0/dyncfs/__init__.py

@@ -0,0 +1,8 @@
+"""
+dyncfs
+==========
+A Python library for computing Coulomb Failure Stress Change in the layered Earth model.
+
+"""
+
+__version__ = "1.0.0"