geone 1.2.16__tar.gz → 1.2.18__tar.gz

{geone-1.2.16/geone.egg-info → geone-1.2.18}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: geone
-Version: 1.2.16
+Version: 1.2.18
 Summary: Geostatistics tools and Multiple Point Statistics
 Author-email: Julien Straubhaar <julien.straubhaar@unine.ch>, Philippe Renard <philippe.renard@unine.ch>
 License: 
@@ -74,11 +74,15 @@ Requires-Dist: numpy<2,>=1
 Requires-Dist: pandas
 Requires-Dist: pyvista
 Requires-Dist: scipy
+Dynamic: license
+Dynamic: license-file
 
 # GEONE
 
 [![Documentation Status](https://readthedocs.org/projects/geone/badge/?version=latest)](https://geone.readthedocs.io/en/latest/?badge=latest)
 
+**Current version : 1.2.18** <!-- Update manually here! see src/geone/_version.py -->
+
 GEONE is a Python3 package providing a set of tools for geostatistical modeling, including:
 
 - multiple-point statistics (MPS) simulation as "DEESSE wrapper"
@@ -109,7 +113,7 @@ GEONE is available:
 
 ### Installation from [PyPI](https://pypi.org/project/geone)
 
-In a terminal type 
+In a terminal type
 ```
 pip install geone
 ```
@@ -128,7 +132,7 @@ pip install .
 
 Alternatively:
 
-- Instead of `git clone ...`, you can download GEONE from the [Github repository](https://github.com/randlab/geone): click on the green button "code" and choose "Download ZIP". 
+- Instead of `git clone ...`, you can download GEONE from the [Github repository](https://github.com/randlab/geone): click on the green button "code" and choose "Download ZIP".
 - Then, unzip the archive on your computer
 - Finally, in a terminal, go into the unzipped directory, and type `pip install .`
 
@@ -152,7 +156,7 @@ The following python packages are used by GEONE (tested on python 3.11.5):
 numpy version **less than 2.** is required
 
 ### Removing GEONE
-In a terminal type 
+In a terminal type
 
 `pip uninstall -y geone`
 
@@ -176,7 +180,7 @@ In a terminal type
 - C. R. Dietrich and G. N. Newsam (1993) A fast and exact method for multidimensional gaussian stochastic simulations. Water Resources Research 29(8):2861-2869, [doi:10.1029/93WR01070](https://dx.doi.org/10.1029/93WR01070)
 - A. T. A. Wood and G. Chan (1994) Simulation of stationary gaussian processes in [0,1]^d. Journal of Computational and Graphical Statistics 3(4):409-432, [doi:10.2307/1390903](https://dx.doi.org/10.2307/1390903)
 
-### Other references 
+### Other references
 - C. Lantuéjoul (2002) Geostatistical Simulation, Models and Algorithms. Springer Verlag, Berlin, 256 p.
 - P. Renard, D. Allard (2013), Connectivity metrics for subsurface flow and transport. Advances in Water Resources 51:168-196, `doi:10.1016/j.advwatres.2011.12.001 <https://doi.org/10.1016/j.advwatres.2011.12.001>`_
 - J. Straubhaar, P. Renard (2024), Exploring substitution random functions composed of stationary multi-Gaussian processes. Stochastic Environmental Research and Risk Assessment, `doi:10.1007/s00477-024-02662-x <https://doi.org/10.1007/s00477-024-02662-x>`_

{geone-1.2.16 → geone-1.2.18}/README.md

@@ -2,6 +2,8 @@
 
 [![Documentation Status](https://readthedocs.org/projects/geone/badge/?version=latest)](https://geone.readthedocs.io/en/latest/?badge=latest)
 
+**Current version : 1.2.18** <!-- Update manually here! see src/geone/_version.py -->
+
 GEONE is a Python3 package providing a set of tools for geostatistical modeling, including:
 
 - multiple-point statistics (MPS) simulation as "DEESSE wrapper"
@@ -32,7 +34,7 @@ GEONE is available:
 
 ### Installation from [PyPI](https://pypi.org/project/geone)
 
-In a terminal type 
+In a terminal type
 ```
 pip install geone
 ```
@@ -51,7 +53,7 @@ pip install .
 
 Alternatively:
 
-- Instead of `git clone ...`, you can download GEONE from the [Github repository](https://github.com/randlab/geone): click on the green button "code" and choose "Download ZIP". 
+- Instead of `git clone ...`, you can download GEONE from the [Github repository](https://github.com/randlab/geone): click on the green button "code" and choose "Download ZIP".
 - Then, unzip the archive on your computer
 - Finally, in a terminal, go into the unzipped directory, and type `pip install .`
 
@@ -75,7 +77,7 @@ The following python packages are used by GEONE (tested on python 3.11.5):
 numpy version **less than 2.** is required
 
 ### Removing GEONE
-In a terminal type 
+In a terminal type
 
 `pip uninstall -y geone`
 
@@ -99,7 +101,7 @@ In a terminal type
 - C. R. Dietrich and G. N. Newsam (1993) A fast and exact method for multidimensional gaussian stochastic simulations. Water Resources Research 29(8):2861-2869, [doi:10.1029/93WR01070](https://dx.doi.org/10.1029/93WR01070)
 - A. T. A. Wood and G. Chan (1994) Simulation of stationary gaussian processes in [0,1]^d. Journal of Computational and Graphical Statistics 3(4):409-432, [doi:10.2307/1390903](https://dx.doi.org/10.2307/1390903)
 
-### Other references 
+### Other references
 - C. Lantuéjoul (2002) Geostatistical Simulation, Models and Algorithms. Springer Verlag, Berlin, 256 p.
 - P. Renard, D. Allard (2013), Connectivity metrics for subsurface flow and transport. Advances in Water Resources 51:168-196, `doi:10.1016/j.advwatres.2011.12.001 <https://doi.org/10.1016/j.advwatres.2011.12.001>`_
 - J. Straubhaar, P. Renard (2024), Exploring substitution random functions composed of stationary multi-Gaussian processes. Stochastic Environmental Research and Risk Assessment, `doi:10.1007/s00477-024-02662-x <https://doi.org/10.1007/s00477-024-02662-x>`_

{geone-1.2.16 → geone-1.2.18/geone.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: geone
-Version: 1.2.16
+Version: 1.2.18
 Summary: Geostatistics tools and Multiple Point Statistics
 Author-email: Julien Straubhaar <julien.straubhaar@unine.ch>, Philippe Renard <philippe.renard@unine.ch>
 License: 
@@ -74,11 +74,15 @@ Requires-Dist: numpy<2,>=1
 Requires-Dist: pandas
 Requires-Dist: pyvista
 Requires-Dist: scipy
+Dynamic: license
+Dynamic: license-file
 
 # GEONE
 
 [![Documentation Status](https://readthedocs.org/projects/geone/badge/?version=latest)](https://geone.readthedocs.io/en/latest/?badge=latest)
 
+**Current version : 1.2.18** <!-- Update manually here! see src/geone/_version.py -->
+
 GEONE is a Python3 package providing a set of tools for geostatistical modeling, including:
 
 - multiple-point statistics (MPS) simulation as "DEESSE wrapper"
@@ -109,7 +113,7 @@ GEONE is available:
 
 ### Installation from [PyPI](https://pypi.org/project/geone)
 
-In a terminal type 
+In a terminal type
 ```
 pip install geone
 ```
@@ -128,7 +132,7 @@ pip install .
 
 Alternatively:
 
-- Instead of `git clone ...`, you can download GEONE from the [Github repository](https://github.com/randlab/geone): click on the green button "code" and choose "Download ZIP". 
+- Instead of `git clone ...`, you can download GEONE from the [Github repository](https://github.com/randlab/geone): click on the green button "code" and choose "Download ZIP".
 - Then, unzip the archive on your computer
 - Finally, in a terminal, go into the unzipped directory, and type `pip install .`
 
@@ -152,7 +156,7 @@ The following python packages are used by GEONE (tested on python 3.11.5):
 numpy version **less than 2.** is required
 
 ### Removing GEONE
-In a terminal type 
+In a terminal type
 
 `pip uninstall -y geone`
 
@@ -176,7 +180,7 @@ In a terminal type
 - C. R. Dietrich and G. N. Newsam (1993) A fast and exact method for multidimensional gaussian stochastic simulations. Water Resources Research 29(8):2861-2869, [doi:10.1029/93WR01070](https://dx.doi.org/10.1029/93WR01070)
 - A. T. A. Wood and G. Chan (1994) Simulation of stationary gaussian processes in [0,1]^d. Journal of Computational and Graphical Statistics 3(4):409-432, [doi:10.2307/1390903](https://dx.doi.org/10.2307/1390903)
 
-### Other references 
+### Other references
 - C. Lantuéjoul (2002) Geostatistical Simulation, Models and Algorithms. Springer Verlag, Berlin, 256 p.
 - P. Renard, D. Allard (2013), Connectivity metrics for subsurface flow and transport. Advances in Water Resources 51:168-196, `doi:10.1016/j.advwatres.2011.12.001 <https://doi.org/10.1016/j.advwatres.2011.12.001>`_
 - J. Straubhaar, P. Renard (2024), Exploring substitution random functions composed of stationary multi-Gaussian processes. Stochastic Environmental Research and Risk Assessment, `doi:10.1007/s00477-024-02662-x <https://doi.org/10.1007/s00477-024-02662-x>`_

{geone-1.2.16 → geone-1.2.18}/src/geone/_version.py

@@ -1,6 +1,6 @@
 # Version
 
 # major, minor, micro
-version_info = (1, 2, 16)
+version_info = (1, 2, 18)
 
 __version__ = '.'.join(map(str, version_info))

{geone-1.2.16 → geone-1.2.18}/src/geone/blockdata.py

@@ -14,6 +14,14 @@ Module for managing block data (for deesse), and relative functions.
 import numpy as np
 import os
 
+# ============================================================================
+class BlockDataError(Exception):
+    """
+    Custom exception related to `blockdata` module.
+    """
+    pass
+# ============================================================================
+
 # ============================================================================
 class BlockData(object):
     """
@@ -36,7 +44,7 @@ class BlockData(object):
         - `nodeIndex[i][j]`: sequence of 3 floats, \
         node index in the simulation grid along x, y, z axis \
         of the j-th node of the i-th block
-        
+
     value : sequence of floats of length `nblock`, optional
         target value for each block (used if `blockDataUsage=1`)
 
@@ -50,6 +58,8 @@ class BlockData(object):
     activatePropMax : sequence of floats of length `nblock`, optional
         maximal proportion of informed nodes in the block, above which the block
         data constraint is deactivated, for each block (used if `blockDataUsage=1`)
+
+    **Methods**
     """
     def __init__(self,
                  blockDataUsage=0,
@@ -87,6 +97,8 @@ class BlockData(object):
             maximal proportion of informed nodes in the block, above which the block
             data constraint is deactivated, for each block
         """
+        # fname = 'BlockData'
+
         self.blockDataUsage = blockDataUsage
         self.nblock = nblock
         self.nodeIndex = nodeIndex
@@ -159,8 +171,8 @@ def readBlockData(filename):
 
     # Check if the file exists
     if not os.path.isfile(filename):
-        print(f'ERROR ({fname}): invalid filename ({filename})')
-        return None
+        err_msg = f'{fname}: invalid filename ({filename})'
+        raise BlockDataError(err_msg)
 
     # Open the file in read mode
     with open(filename,'r') as ff:
@@ -211,6 +223,7 @@ def writeBlockData(bd, filename, fmt='.5g'):
         format string for target value, tolerance and active proportion (min
         and max) in the block data
     """
+    # fname = 'writeBlockData'
 
     if bd.blockDataUsage == 0:
         return None