feat: rename all instances of catalog_tools to seismostats

swiss-seismological-service · Oct 29, 2023 · 978fd98 · 978fd98
1 parent 64a4e86
commit 978fd98
Show file tree

Hide file tree

Showing 39 changed files with 280 additions and 260 deletions.
diff --git a/catalog_Tools.ipynb b/catalog_Tools.ipynb
diff --git a/catalog_tools/__init__.py b/catalog_tools/__init__.py
diff --git a/seismostats/__init__.py b/seismostats/__init__.py
@@ -0,0 +1,22 @@
+"""All functions that are to be used externally are initialized here"""
+# flake8: noqa
+
+# analysis
+from seismostats.analysis.estimate_beta import (estimate_b_elst,
+                                                estimate_b_laplace,
+                                                estimate_b_tinti,
+                                                estimate_b_utsu,
+                                                estimate_beta_tinti,
+                                                shi_bolt_confidence)
+# plots
+from seismostats.plots.basics import (plot_cum_count, plot_cum_fmd, plot_fmd,
+                                      plot_mags_in_time)
+from seismostats.plots.seismicity import plot_in_space
+from seismostats.plots.statistical import plot_mc_vs_b
+# seismicity
+from seismostats.seismicity.catalog import Catalog, ForecastCatalog
+from seismostats.seismicity.rategrid import ForecastGRRateGrid, GRRateGrid
+# utils
+from seismostats.utils.binning import bin_to_precision
+from seismostats.utils.filtering import cat_intersect_polygon
+from seismostats.utils.simulate_distributions import simulate_magnitudes
diff --git a/catalog_tools/analysis/__init__.py → seismostats/analysis/__init__.py b/catalog_tools/analysis/__init__.py → seismostats/analysis/__init__.py
diff --git a/catalog_tools/analysis/estimate_beta.py → seismostats/analysis/estimate_beta.py b/catalog_tools/analysis/estimate_beta.py → seismostats/analysis/estimate_beta.py
diff --git a/catalog_tools/analysis/estimate_mc.py → seismostats/analysis/estimate_mc.py b/catalog_tools/analysis/estimate_mc.py → seismostats/analysis/estimate_mc.py
@@ -4,9 +4,9 @@
 import numpy as np
 import pandas as pd
 
-from catalog_tools.analysis.estimate_beta import estimate_beta_tinti
-from catalog_tools.utils.binning import normal_round
-from catalog_tools.utils.simulate_distributions import simulate_magnitudes
+from seismostats.analysis.estimate_beta import estimate_beta_tinti
+from seismostats.utils.binning import normal_round
+from seismostats.utils.simulate_distributions import simulate_magnitudes
 
 
 def fitted_cdf_discrete(
@@ -152,7 +152,7 @@ def ks_test_gr(
         )
 
         for i in range(n_samples):
-            simulated = simulated_all[n_sample * i : n_sample * (i + 1)].copy()
+            simulated = simulated_all[n_sample * i: n_sample * (i + 1)].copy()
             x_emp, y_emp = empirical_cdf(simulated)
             y_fit_int = np.interp(x_emp, x_fit, y_fit)
 

diff --git a/catalog_tools/analysis/magnitudes.py → seismostats/analysis/magnitudes.py b/catalog_tools/analysis/magnitudes.py → seismostats/analysis/magnitudes.py
diff --git a/...ools/analysis/tests/test_estimate_beta.py → ...tats/analysis/tests/test_estimate_beta.py b/...ools/analysis/tests/test_estimate_beta.py → ...tats/analysis/tests/test_estimate_beta.py
@@ -2,16 +2,16 @@
 import pytest
 
 # import functions to be tested
-from catalog_tools.analysis.estimate_beta import (differences, estimate_b_elst,
-                                                  estimate_b_laplace,
-                                                  estimate_b_tinti,
-                                                  estimate_b_utsu,
-                                                  estimate_b_weichert,
-                                                  estimate_beta_tinti,
-                                                  shi_bolt_confidence)
-from catalog_tools.utils.binning import bin_to_precision
+from seismostats.analysis.estimate_beta import (differences, estimate_b_elst,
+                                                estimate_b_laplace,
+                                                estimate_b_tinti,
+                                                estimate_b_utsu,
+                                                estimate_b_weichert,
+                                                estimate_beta_tinti,
+                                                shi_bolt_confidence)
+from seismostats.utils.binning import bin_to_precision
 # import functions from other modules
-from catalog_tools.utils.simulate_distributions import simulate_magnitudes
+from seismostats.utils.simulate_distributions import simulate_magnitudes
 
 
 def simulate_magnitudes_w_offset(

diff --git a/..._tools/analysis/tests/test_estimate_mc.py → ...ostats/analysis/tests/test_estimate_mc.py b/..._tools/analysis/tests/test_estimate_mc.py → ...ostats/analysis/tests/test_estimate_mc.py
@@ -1,7 +1,7 @@
 import numpy as np
 from numpy.testing import assert_allclose, assert_equal
 
-from catalog_tools.analysis.estimate_mc import empirical_cdf, estimate_mc
+from seismostats.analysis.estimate_mc import empirical_cdf, estimate_mc
 
 
 def test_empirical_cdf():

diff --git a/...g_tools/analysis/tests/test_magnitudes.py → ...mostats/analysis/tests/test_magnitudes.py b/...g_tools/analysis/tests/test_magnitudes.py → ...mostats/analysis/tests/test_magnitudes.py
@@ -1,6 +1,6 @@
 from numpy.testing import assert_almost_equal, assert_equal
 
-from catalog_tools.analysis.magnitudes import apply_edwards
+from seismostats.analysis.magnitudes import apply_edwards
 
 
 def test_apply_edwards():

diff --git a/catalog_tools/io/__init__.py → seismostats/io/__init__.py b/catalog_tools/io/__init__.py → seismostats/io/__init__.py
diff --git a/catalog_tools/io/client.py → seismostats/io/client.py b/catalog_tools/io/client.py → seismostats/io/client.py
@@ -3,8 +3,8 @@
 import pandas as pd
 import requests
 
-from catalog_tools import Catalog
-from catalog_tools.io.parser import parse_quakeml_response
+from seismostats import Catalog
+from seismostats.io.parser import parse_quakeml_response
 
 
 class FDSNWSEventClient():

diff --git a/catalog_tools/io/parser.py → seismostats/io/parser.py b/catalog_tools/io/parser.py → seismostats/io/parser.py
diff --git a/catalog_tools/io/tests/query.xml → seismostats/io/tests/query.xml b/catalog_tools/io/tests/query.xml → seismostats/io/tests/query.xml
diff --git a/catalog_tools/io/tests/test_client.py → seismostats/io/tests/test_client.py b/catalog_tools/io/tests/test_client.py → seismostats/io/tests/test_client.py
@@ -5,8 +5,8 @@
 from pandas.api.types import is_datetime64_any_dtype, is_numeric_dtype
 from responses import matchers
 
-from catalog_tools import Catalog
-from catalog_tools.io.client import FDSNWSEventClient
+from seismostats import Catalog
+from seismostats.io.client import FDSNWSEventClient
 
 PATH_RESOURCES = os.path.join(os.path.dirname(os.path.abspath(__file__)),
                               'query.xml')

diff --git a/catalog_tools/io/tests/test_parser.py → seismostats/io/tests/test_parser.py b/catalog_tools/io/tests/test_parser.py → seismostats/io/tests/test_parser.py
@@ -3,7 +3,7 @@
 
 import numpy as np
 
-from catalog_tools.io.parser import QuakeMLHandler, parse_quakeml
+from seismostats.io.parser import QuakeMLHandler, parse_quakeml
 
 OUT = [{'depth': '1181.640625',
         'depth_uncertainty': '274.9552879',

diff --git a/catalog_tools/plots/__init__.py → seismostats/plots/__init__.py b/catalog_tools/plots/__init__.py → seismostats/plots/__init__.py
diff --git a/catalog_tools/plots/basics.py → seismostats/plots/basics.py b/catalog_tools/plots/basics.py → seismostats/plots/basics.py
@@ -3,7 +3,7 @@
 import pandas as pd
 
 # Own functions
-from catalog_tools.utils.binning import get_cum_fmd, get_fmd
+from seismostats.utils.binning import get_cum_fmd, get_fmd
 
 
 def gutenberg_richter(magnitudes: np.ndarray, b_value: float,

diff --git a/catalog_tools/plots/seismicity.py → seismostats/plots/seismicity.py b/catalog_tools/plots/seismicity.py → seismostats/plots/seismicity.py
@@ -7,12 +7,11 @@
 import pandas as pd
 from cartopy.io import shapereader
 from cartopy.mpl.gridliner import LATITUDE_FORMATTER, LONGITUDE_FORMATTER
-
 # for map plotting
 from shapely.geometry import Polygon
 
 # Own functions
-from catalog_tools.plots.basics import dot_size
+from seismostats.plots.basics import dot_size
 
 
 def plot_in_space(

diff --git a/catalog_tools/plots/statistical.py → seismostats/plots/statistical.py b/catalog_tools/plots/statistical.py → seismostats/plots/statistical.py
@@ -1,15 +1,12 @@
 # standard
 import matplotlib.pyplot as plt
 import numpy as np
-
 # statistical
 from scipy.stats import norm
 
 # Own functions
-from catalog_tools.analysis.estimate_beta import (
-    estimate_b_elst,
-    estimate_b_tinti,
-)
+from seismostats.analysis.estimate_beta import (estimate_b_elst,
+                                                estimate_b_tinti)
 
 
 def plot_mc_vs_b(

diff --git a/catalog_tools/plots/tests/test_basics.py → seismostats/plots/tests/test_basics.py b/catalog_tools/plots/tests/test_basics.py → seismostats/plots/tests/test_basics.py
@@ -1,7 +1,7 @@
 import numpy as np
 from numpy.testing import assert_allclose
 
-from catalog_tools.plots.basics import dot_size
+from seismostats.plots.basics import dot_size
 
 
 def test_dot_size():

diff --git a/catalog_tools/seismicity/__init__.py → seismostats/seismicity/__init__.py b/catalog_tools/seismicity/__init__.py → seismostats/seismicity/__init__.py
diff --git a/catalog_tools/seismicity/catalog.py → seismostats/seismicity/catalog.py b/catalog_tools/seismicity/catalog.py → seismostats/seismicity/catalog.py
@@ -6,10 +6,10 @@
 
 import pandas as pd
 
-from catalog_tools.io.parser import parse_quakeml, parse_quakeml_file
-from catalog_tools.utils import (_check_required_cols, _render_template,
-                                 require_cols)
-from catalog_tools.utils.binning import bin_to_precision
+from seismostats.io.parser import parse_quakeml, parse_quakeml_file
+from seismostats.utils import (_check_required_cols, _render_template,
+                               require_cols)
+from seismostats.utils.binning import bin_to_precision
 
 REQUIRED_COLS_CATALOG = ['longitude', 'latitude', 'depth',
                          'time', 'magnitude']

diff --git a/.../seismicity/catalog_templates/__init__.py → .../seismicity/catalog_templates/__init__.py b/.../seismicity/catalog_templates/__init__.py → .../seismicity/catalog_templates/__init__.py
diff --git a/...s/seismicity/catalog_templates/quakeml.j2 → ...s/seismicity/catalog_templates/quakeml.j2 b/...s/seismicity/catalog_templates/quakeml.j2 → ...s/seismicity/catalog_templates/quakeml.j2
diff --git a/catalog_tools/seismicity/rategrid.py → seismostats/seismicity/rategrid.py b/catalog_tools/seismicity/rategrid.py → seismostats/seismicity/rategrid.py
@@ -3,7 +3,7 @@
 import numpy as np
 import pandas as pd
 
-from catalog_tools.utils import _check_required_cols, require_cols
+from seismostats.utils import _check_required_cols, require_cols
 
 REQUIRED_COLS_RATEGRID = [
     'longitude_min', 'longitude_max',

diff --git a/...ls/seismicity/tests/data/quakeml_data.xml → ...ts/seismicity/tests/data/quakeml_data.xml b/...ls/seismicity/tests/data/quakeml_data.xml → ...ts/seismicity/tests/data/quakeml_data.xml
diff --git a/...og_tools/seismicity/tests/test_catalog.py → seismostats/seismicity/tests/test_catalog.py b/...og_tools/seismicity/tests/test_catalog.py → seismostats/seismicity/tests/test_catalog.py
@@ -4,9 +4,9 @@
 
 import pandas as pd
 
-from catalog_tools.seismicity.catalog import (REQUIRED_COLS_CATALOG, Catalog,
-                                              ForecastCatalog)
-from catalog_tools.utils.binning import bin_to_precision
+from seismostats.seismicity.catalog import (REQUIRED_COLS_CATALOG, Catalog,
+                                            ForecastCatalog)
+from seismostats.utils.binning import bin_to_precision
 
 RAW_DATA = {'name': ['Object 1', 'Object 2', 'Object 3'],
             'magnitude': [10.0, 12.5, 8.2],

diff --git a/...g_tools/seismicity/tests/test_rategrid.py → ...mostats/seismicity/tests/test_rategrid.py b/...g_tools/seismicity/tests/test_rategrid.py → ...mostats/seismicity/tests/test_rategrid.py
@@ -3,8 +3,8 @@
 import pandas as pd
 import pytest
 
-from catalog_tools.seismicity.rategrid import (REQUIRED_COLS_RATEGRID,
-                                               ForecastGRRateGrid, GRRateGrid)
+from seismostats.seismicity.rategrid import (REQUIRED_COLS_RATEGRID,
+                                             ForecastGRRateGrid, GRRateGrid)
 
 RAW_DATA = {
     'longitude_min': [-180, -90, 0, 90],

diff --git a/catalog_tools/utils/__init__.py → seismostats/utils/__init__.py b/catalog_tools/utils/__init__.py → seismostats/utils/__init__.py
diff --git a/catalog_tools/utils/binning.py → seismostats/utils/binning.py b/catalog_tools/utils/binning.py → seismostats/utils/binning.py
diff --git a/catalog_tools/utils/coordinates.py → seismostats/utils/coordinates.py b/catalog_tools/utils/coordinates.py → seismostats/utils/coordinates.py
diff --git a/catalog_tools/utils/filtering.py → seismostats/utils/filtering.py b/catalog_tools/utils/filtering.py → seismostats/utils/filtering.py
diff --git a/...log_tools/utils/simulate_distributions.py → seismostats/utils/simulate_distributions.py b/...log_tools/utils/simulate_distributions.py → seismostats/utils/simulate_distributions.py
diff --git a/catalog_tools/utils/tests/test_binning.py → seismostats/utils/tests/test_binning.py b/catalog_tools/utils/tests/test_binning.py → seismostats/utils/tests/test_binning.py
@@ -1,10 +1,8 @@
-from catalog_tools.utils.binning import normal_round_to_int, normal_round
-from catalog_tools.utils.binning import bin_to_precision
-from catalog_tools.utils.binning import get_fmd, get_cum_fmd
-
-
-import pytest
 import numpy as np
+import pytest
+
+from seismostats.utils.binning import (bin_to_precision, get_cum_fmd, get_fmd,
+                                       normal_round, normal_round_to_int)
 
 
 @pytest.mark.parametrize(

diff --git a/...tils/tests/test_coordinate_transformer.py → ...tils/tests/test_coordinate_transformer.py b/...tils/tests/test_coordinate_transformer.py → ...tils/tests/test_coordinate_transformer.py
@@ -2,7 +2,7 @@
 
 import unittest
 
-from catalog_tools.utils.coordinates import CoordinateTransformer
+from seismostats.utils.coordinates import CoordinateTransformer
 
 WGS84_PROJ = "epsg:4326"
 SWISS_PROJ = "epsg:2056"

diff --git a/catalog_tools/utils/tests/test_filtering.py → seismostats/utils/tests/test_filtering.py b/catalog_tools/utils/tests/test_filtering.py → seismostats/utils/tests/test_filtering.py
@@ -1,8 +1,8 @@
-import pandas as pd
 import numpy as np
+import pandas as pd
 
 # import functions to be tested
-from catalog_tools.utils.filtering import cat_intersect_polygon
+from seismostats.utils.filtering import cat_intersect_polygon
 
 
 def test_cat_intersect_polygon():

diff --git a/...og_tools/utils/tests/test_require_cols.py → seismostats/utils/tests/test_require_cols.py b/...og_tools/utils/tests/test_require_cols.py → seismostats/utils/tests/test_require_cols.py
@@ -1,6 +1,6 @@
 import pytest
 
-from catalog_tools.utils import require_cols
+from seismostats.utils import require_cols
 
 REQUIRED = ['longitude', 'latitude', 'depth',
                          'time', 'magnitude']

diff --git a/setup.cfg b/setup.cfg
@@ -1,7 +1,7 @@
 [metadata]
-name = catalog-tools
+name = SeismoStats
 version = 0.1
-description = Best Catalog Tools
+description = Library for statistical analysis of seismicity.
 license = GNU AFFERO GENERAL PUBLIC LICENSE
 
 [options]
@@ -11,23 +11,18 @@ install_requires =
     cartopy
     geopandas
     jinja2
-    matplotlib
-    numpy
-    pandas
     scipy
-    shapely
 
 
 [options.packages.find]
-include=catalog_tools*
+include=seismostats*
 
 [options.package_data]
 * =
   *.j2
 
 [options.extras_require]
 dev =
-    autopep8
     flake8
     isort
     pytest