pygeoinf 1.2.8__py3-none-any.whl → 1.2.9__py3-none-any.whl

pygeoinf/symmetric_space/sphere.py

@@ -29,10 +29,16 @@ import matplotlib.ticker as mticker
 import numpy as np
 from scipy.sparse import diags, coo_array
 
-import pyshtools as sh
-import cartopy.crs as ccrs
-import cartopy.feature as cfeature
-from cartopy.mpl.ticker import LongitudeFormatter, LatitudeFormatter
+try:
+    import pyshtools as sh
+    import cartopy.crs as ccrs
+    import cartopy.feature as cfeature
+    from cartopy.mpl.ticker import LongitudeFormatter, LatitudeFormatter
+except ImportError:
+    raise ImportError(
+        "pyshtools and cartopy are required for the sphere module. "
+        "Please install them with 'pip install pygeoinf[sphere]'"
+    )
 
 from pygeoinf.hilbert_space import (
     HilbertModule,

{pygeoinf-1.2.8.dist-info → pygeoinf-1.2.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pygeoinf
-Version: 1.2.8
+Version: 1.2.9
 Summary: A package for solving geophysical inference and inverse problems
 License: BSD-3-Clause
 Author: David Al-Attar and Dan Heathcote
@@ -10,12 +10,11 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: Cartopy (>=0.23.0,<0.24.0)
+Provides-Extra: sphere
 Requires-Dist: joblib (>=1.5.2,<2.0.0)
 Requires-Dist: matplotlib (>=3.0.0)
 Requires-Dist: numpy (>=1.26.0)
 Requires-Dist: pyqt6 (>=6.0.0)
-Requires-Dist: pyshtools (>=4.0.0)
 Requires-Dist: scipy (>=1.16.1)
 Description-Content-Type: text/markdown
 
@@ -47,16 +46,31 @@ The library is built on a few key concepts:
 * **Optimisation Methods**: Includes Tikhonov-regularized least-squares and minimum-norm solutions.
 * **Probabilistic Modelling**: Define priors and noise models using `GaussianMeasure` objects on abstract spaces.
 * **Randomized Algorithms**: Utilizes randomized SVD and Cholesky decompositions for efficient low-rank approximations of large operators.
+* **Specialized Operator Variants**: Efficient implementations for `DiagonalSparseMatrixLinearOperator` and `NormalSumOperator`.
 * **Application-Specific Spaces**: Provides concrete `HilbertSpace` implementations for functions on a **line**, **circle**, and the **two-sphere**.
 * **High-Quality Visualisation**: Built-in plotting methods for functions on symmetric spaces, including map projections via `cartopy`.
 
+## Advanced Features
+
+* **Block Operators**: Construct complex operators from smaller components using `BlockLinearOperator`, `ColumnLinearOperator`, and `RowLinearOperator`. This is ideal for coupled inverse problems.
+* **Parallelisation**: Many expensive operations are parallelized with `joblib`, including dense matrix construction and randomized algorithms.
+
 ## Installation
 
-The package can be installed directly using pip:
+The package can be installed directly using pip. By default, this will perform a minimal installation.
 
 ```bash
+# Minimal installation
 pip install pygeoinf
 ```
+
+To include the functionality for functions on the sphere, you can install the `sphere` extra. This provides support for `pyshtools` and `Cartopy`.
+
+```bash
+# Installation with sphere-related features
+pip install pygeoinf[sphere]
+```
+
 For development, you can clone the repository and install using Poetry:
 
 ```bash
@@ -64,6 +78,7 @@ git clone https://github.com/da380/pygeoinf.git
 cd pygeoinf
 poetry install
 ```
+
 You can install all optional dependencies for development—including tools for running the test suite, 
 building the documentation, and running the Jupyter tutorials—by using the ```--with``` flag and specifying the ```dev``` group.
 
@@ -233,20 +248,30 @@ The output of the above script will look similar to the following figure:
 * NumPy
 * SciPy
 * Matplotlib
-* pyshtools (for `sphere.py`)
-* Cartopy (for plotting in `sphere.py`)
+* joblib
 
-## Future Plans
+### Optional (`sphere`)
+
+* pyshtools
+* Cartopy
+
+## Recent Updates
+
+`pygeoinf` is under active development, and recent updates have expanded its capabilities to address a broader range of geophysical problems. Key improvements include:
 
-`pygeoinf` is under active development. Current work is focused on expanding the library's capabilities to address a broader range of geophysical problems. Key areas for development include:
+* **Non-Linear Inverse Problems**: The library now supports non-linear inverse problems through the `NonLinearOperator` and `NonLinearForm` classes. This allows you to define and solve problems where the relationship between model parameters and data is non-linear. The framework includes support for Fréchet derivatives, enabling the use of gradient-based optimisation methods.
 
-* **Generalised Backus-Gilbert Methods**: Implementation of a generalised Backus-Gilbert framework for linear inference problems. The focus will be on constructing direct estimates of specific properties of interest (i.e., linear functionals of the model) from data, without needing to first solve for the full model itself.
+* **Advanced Optimisation Algorithms**: To complement the non-linear framework, `pygeoinf` now includes a suite of optimisation algorithms. You can use the custom `GradientDescent` solver or leverage the power of SciPy's optimization library with methods like 'BFGS', 'L-BFGS-B', and 'Newton-CG'. Derivative-free methods such as 'Powell' and 'Nelder-Mead' are also supported for problems where gradients are unavailable.
+
+* **Backus-Gilbert Methods**: The foundations for the Backus-Gilbert method have been implemented. While this feature is still evolving, the core components are in place for you to begin exploring this powerful inference technique.
+
+## Future Plans
 
-* **Non-linear Optimisation**: Extension of the current optimisation framework to handle non-linear inverse problems. This will involve creating a general interface where users can provide their own non-linear forward mapping, a misfit functional, and methods for computing gradients (and optionally Hessians) for use in gradient-based optimisation algorithms.
+Future development will focus on the following areas:
 
-* **Non-linear Bayesian Inference**: Development of methods for non-linear Bayesian problems. Planned approaches include linearizing the problem around the maximum a posteriori (MAP) solution to estimate posterior uncertainty, and using this linearization to construct efficient proposal distributions for Markov chain Monte Carlo (MCMC) sampling methods.
+* **Non-linear Bayesian Inference**: We plan to develop methods for non-linear Bayesian problems, including techniques for linearizing the problem around the maximum a posteriori (MAP) solution to estimate posterior uncertainty. This will also involve constructing efficient proposal distributions for Markov chain Monte Carlo (MCMC) sampling methods.
 
-* **New Geophysical Hilbert Spaces**: Addition of further `HilbertSpace` implementations tailored to specific geophysical applications. A primary focus will be on creating spaces for functions defined within a **spherical annulus** (spherical shell), which is essential for problems in global seismology and mantle tomography.
+* **New Geophysical Hilbert Spaces**: We will be adding more `HilbertSpace` implementations for specific geophysical applications. A key focus will be on creating spaces for functions defined within a **spherical annulus** (spherical shell), which is crucial for problems in global seismology and mantle tomography.
 
 
 ## Contributing

{pygeoinf-1.2.8.dist-info → pygeoinf-1.2.9.dist-info}/RECORD

@@ -20,9 +20,9 @@ pygeoinf/parallel.py,sha256=VVFvNHszy4wSa9LuErIsch4NAkLaZezhdN9YpRROBJo,2267
 pygeoinf/random_matrix.py,sha256=71l6eAXQ2pRMleaz1lXud6O1F78ugKyp3vHcRBXhdwM,17661
 pygeoinf/symmetric_space/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pygeoinf/symmetric_space/circle.py,sha256=7Bz9BfSkbDnoz5-HFwTsAQE4a09jUapBePwoCK0xYWw,18007
-pygeoinf/symmetric_space/sphere.py,sha256=5elw48I8A2i5EuRyYnm4craVp-ZB2_bBy9QQ15GytxE,23144
+pygeoinf/symmetric_space/sphere.py,sha256=8mIny_KNP2MCpVxqIFKEgXc1_EIDesVz65OhUtRVsuQ,23349
 pygeoinf/symmetric_space/symmetric_space.py,sha256=Q3KtfCtHO0_8LjsdKtH-5WVhRQurt5Bdk4yx1D2F5YY,17977
-pygeoinf-1.2.8.dist-info/LICENSE,sha256=GrTQnKJemVi69FSbHprq60KN0OJGsOSR-joQoTq-oD8,1501
-pygeoinf-1.2.8.dist-info/METADATA,sha256=BLWdHc9FE8C4X7L0y9xHAdQfY3_pkzljiNPIPZAqfH4,15169
-pygeoinf-1.2.8.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
-pygeoinf-1.2.8.dist-info/RECORD,,
+pygeoinf-1.2.9.dist-info/LICENSE,sha256=GrTQnKJemVi69FSbHprq60KN0OJGsOSR-joQoTq-oD8,1501
+pygeoinf-1.2.9.dist-info/METADATA,sha256=dBoRWZKHNcr7PIhPki7pU9oIFLy0FQtJOvI6dIp39no,16292
+pygeoinf-1.2.9.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+pygeoinf-1.2.9.dist-info/RECORD,,