geostats-datasets 0.1.0__tar.gz

geostats_datasets-0.1.0/.gitignore

@@ -0,0 +1,5 @@
+.venv/
+dist/
+__pycache__/
+oil-gas/3d/f3-survey/*.csv
+oil-gas/3d/f3-survey/*.sgy

geostats_datasets-0.1.0/LICENSE-CODE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Gustavo Pretto Scholze
+
+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.

geostats_datasets-0.1.0/PKG-INFO

@@ -0,0 +1,40 @@
+Metadata-Version: 2.5
+Name: geostats-datasets
+Version: 0.1.0
+Summary: Download mining and oil & gas geostatistics datasets by name.
+Project-URL: Homepage, https://github.com/gstvschlz/datasets
+Project-URL: Issues, https://github.com/gstvschlz/datasets/issues
+Author: Gustavo Pretto Scholze
+License-Expression: MIT
+License-File: LICENSE-CODE
+Keywords: datasets,drill holes,geostatistics,kriging,mining,oil and gas,training images
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: GIS
+Requires-Python: >=3.10
+Requires-Dist: pooch>=1.7
+Description-Content-Type: text/markdown
+
+# geostats-datasets
+
+Download 2D and 3D geostatistics datasets for mining and oil & gas by name: classic public
+sets (Walker Lake, Jura, Strebelle and other training images, the F3 survey) and synthetic
+case studies (drill holes, blastholes, block models, well logs, solids).
+
+```python
+import geostats_datasets as gd
+
+gd.list()                              # ['bangladesh', 'coal-seam', ...]
+folder = gd.fetch("walker-lake")       # downloads once, returns the local folder
+sample = gd.fetch("walker-lake", "sample.csv")
+```
+
+Or from the shell: `python -m geostats_datasets fetch walker-lake`.
+
+Each dataset comes as a zip from the repository's GitHub data release, checked against its
+sha256 and cached per user (set `GEOSTATS_DATASETS_DIR` to move the cache). Every folder has a
+README with each file, each column, units, ranges and suggested exercises.
+
+Catalogue, previews and licenses: https://github.com/gstvschlz/datasets

geostats_datasets-0.1.0/pyproject.toml

@@ -0,0 +1,62 @@
+[project]
+name = "geostats-datasets"
+dynamic = ["version"]
+description = "Download mining and oil & gas geostatistics datasets by name."
+readme = { content-type = "text/markdown", text = """
+# geostats-datasets
+
+Download 2D and 3D geostatistics datasets for mining and oil & gas by name: classic public
+sets (Walker Lake, Jura, Strebelle and other training images, the F3 survey) and synthetic
+case studies (drill holes, blastholes, block models, well logs, solids).
+
+```python
+import geostats_datasets as gd
+
+gd.list()                              # ['bangladesh', 'coal-seam', ...]
+folder = gd.fetch("walker-lake")       # downloads once, returns the local folder
+sample = gd.fetch("walker-lake", "sample.csv")
+```
+
+Or from the shell: `python -m geostats_datasets fetch walker-lake`.
+
+Each dataset comes as a zip from the repository's GitHub data release, checked against its
+sha256 and cached per user (set `GEOSTATS_DATASETS_DIR` to move the cache). Every folder has a
+README with each file, each column, units, ranges and suggested exercises.
+
+Catalogue, previews and licenses: https://github.com/gstvschlz/datasets
+""" }
+license = "MIT"
+license-files = ["LICENSE-CODE"]
+authors = [{ name = "Gustavo Pretto Scholze" }]
+requires-python = ">=3.10"
+dependencies = ["pooch>=1.7"]
+keywords = ["geostatistics", "datasets", "mining", "oil and gas", "kriging", "training images", "drill holes"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: Education",
+    "Programming Language :: Python :: 3",
+    "Topic :: Scientific/Engineering :: GIS",
+]
+
+[project.urls]
+Homepage = "https://github.com/gstvschlz/datasets"
+Issues = "https://github.com/gstvschlz/datasets/issues"
+
+[dependency-groups]
+dev = ["pytest>=8", "ruff>=0.6"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+path = "src/geostats_datasets/__init__.py"
+
+[tool.hatch.build.targets.sdist]
+include = ["src"]
+
+[tool.ruff]
+line-length = 100
+# Dataset scripts are data provenance: reformatting them would change their published zips.
+extend-exclude = ["mining", "oil-gas"]

geostats_datasets-0.1.0/src/geostats_datasets/__init__.py

@@ -0,0 +1,51 @@
+"""Download mining and oil & gas geostatistics datasets by name and cache them locally."""
+
+import os
+import shutil
+import zipfile
+from pathlib import Path
+
+import pooch
+
+__version__ = "0.1.0"
+
+# The GitHub release holding one <dataset>.zip per dataset.
+DATA_RELEASE = "data-v1.0.0"
+
+_DATA = pooch.create(
+    path=Path(os.environ.get("GEOSTATS_DATASETS_DIR") or pooch.os_cache("geostats-datasets"))
+    / DATA_RELEASE,
+    base_url=f"https://github.com/gstvschlz/datasets/releases/download/{DATA_RELEASE}/",
+)
+_DATA.load_registry(Path(__file__).with_name("registry.txt"))
+
+
+def list():
+    """Names of all datasets, e.g. 'walker-lake'."""
+    return sorted(name.removesuffix(".zip") for name in _DATA.registry)
+
+
+def fetch(name, file=None):
+    """Download a dataset and return the local path of its folder, or of one of its files.
+
+    The zip is checked against its sha256, downloaded once and unpacked into the cache.
+    """
+    if f"{name}.zip" not in _DATA.registry:
+        raise ValueError(f"Unknown dataset {name!r}; see geostats_datasets.list() for names.")
+    archive = Path(_DATA.fetch(f"{name}.zip"))
+    folder = archive.with_suffix("")
+    if not folder.exists():
+        # Unpack beside the cache and move into place, so an interrupted unpack leaves no folder.
+        partial = archive.with_suffix(".partial")
+        shutil.rmtree(partial, ignore_errors=True)
+        with zipfile.ZipFile(archive) as zipped:
+            zipped.extractall(partial)
+        (partial / name).rename(folder)
+        shutil.rmtree(partial)
+    if file is None:
+        return folder
+    path = folder / file
+    if not path.is_file():
+        files = sorted(p.relative_to(folder).as_posix() for p in folder.rglob("*") if p.is_file())
+        raise ValueError(f"{name!r} has no file {file!r}; its files are: {', '.join(files)}.")
+    return path

geostats_datasets-0.1.0/src/geostats_datasets/__main__.py

@@ -0,0 +1,16 @@
+import argparse
+
+import geostats_datasets
+
+parser = argparse.ArgumentParser(prog="python -m geostats_datasets")
+commands = parser.add_subparsers(dest="command", required=True)
+commands.add_parser("list", help="print the dataset names")
+fetch = commands.add_parser("fetch", help="download a dataset and print its local path")
+fetch.add_argument("name", help="dataset name, e.g. walker-lake")
+fetch.add_argument("file", nargs="?", help="one file of the dataset, e.g. sample.csv")
+args = parser.parse_args()
+
+if args.command == "list":
+    print("\n".join(geostats_datasets.list()))
+else:
+    print(geostats_datasets.fetch(args.name, args.file))

geostats_datasets-0.1.0/src/geostats_datasets/registry.txt

@@ -0,0 +1,23 @@
+bangladesh.zip 2450384fbaff3576e2ce687f4c613a200d48e0fe4ed7b0e881e94bbde913cd95
+coal-seam.zip 34cdad454f464c463406bdfc62f22e563cd91828bc76f09e7c7d7bfeb5bd2fe5
+deviated-well-logs.zip 4da728c258998c4e173b23a7021da502f1abe420d716feae8b4fa67c15dd6640
+dunes.zip 7fbe419adc03983c356b3114cd37502f75dab22f04af69949d6735703841b104
+f3-survey.zip f253c4366fec1c3a24878d7e491db40e479768c8948f590b180466d50b1d4a18
+facies-between-horizons.zip fa00c17846406402e6cddee5256b375e0104951a0087e75d581622ad8e958e8e
+fluvial-channel-reservoir.zip b2369f33f5d1d21960f1981bb86eb4a49f2b7bb570125ec142838597a489e3f2
+gold-copper-soils.zip 69c8dcc72f21b5588f0d9a9e7123479eb12e3d6a9f4a0da75601ab4af90f4cfe
+gold-tailings.zip c6d813c76bedbd203aef133be3ca962d116df81e7ff506ded5faf71f73569d38
+gold-veins.zip 42a19417ef2e7d85b6d65409ba5628dc46e1717baa29edfb83facedc1ba456a2
+iron-formation.zip ed4e69df09dc77655f7303d87efd5939e40e7a7b0c2e55a9545e3776c7049581
+jura.zip 8ef4e256d65bcb8e2b48f7d49fce86cc649dc6d17de55c232a84dc3f32c5fb79
+lena-delta.zip b7c60719b011a00198d6629423815c75e41342c896ffc240a2669bdfa58f1e23
+nickel-laterite.zip 5e7f89ec46961fdd2c32e967020660813e5bb80698cfbd7b94b81e71645631e3
+ohau.zip cacb1b404d456ad5fc9c4eb888e3f311918c4f941df26ce11c6e85da13fe1bfe
+phosphate-regolith.zip ca880095043bc6a281bdb415f33d1ebb5e36050a0d63ce4b5c08745b7cc801aa
+pore-scale-grain-image.zip 9f36cfd9c07b39ee230da688d403d2f8a6ccca75cdf0bb9d3387d34cf681f286
+porphyry-geometallurgy.zip 07e8494148f8c7a6c9e89a7f4ed232ae23f6490e29241d61963d52447971aa15
+seismic-guided-porosity.zip 2f709807e6075b6fc48812c451394d9a38b69202ad411a522e88917be85e28f1
+strebelle.zip 60130de1de0a4ec178566f519f337a70a718be13c70fc2d80fd659696fbbe073
+walker-lake.zip b3491d4fe13b61fbc155f2b4a7ee8e39f25e95224f354294ce9290dc6b0afdf8
+west-coast-africa.zip 0cdcbfc6cdca32ba1b0bfe5d6247c8e0e32ddac2b3d67bcd6819951caab1b7fb
+zinc-vms-lenses.zip d1c8720c639811c41ca36eed7fbea236c97541d79f15d7f93cfdb160bf0cf969