oreblocks 0.1.0__tar.gz

oreblocks-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

oreblocks-0.1.0/PKG-INFO

@@ -0,0 +1,91 @@
+Metadata-Version: 2.4
+Name: oreblocks
+Version: 0.1.0
+Summary: Synthetic 3D ore-body block models of the MineLib nature: seeded deposit archetypes, bench structure, slope precedence, UPIT economics, an exact max-closure solver, extraction states with loading faces, and MineLib .blocks/.prec/.upit read/write
+Author: Felipe Santibanez-Leal
+License: Apache-2.0
+Project-URL: Repository, https://github.com/fsantibanezleal/CAOS_OreBlocks
+Project-URL: Changelog, https://github.com/fsantibanezleal/CAOS_OreBlocks/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/fsantibanezleal/CAOS_OreBlocks/issues
+Keywords: mining,block-model,ore-body,ultimate-pit,UPIT,MineLib,open-pit,mine-planning,max-closure,synthetic-data
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.26
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: ruff>=0.4; extra == "dev"
+Dynamic: license-file
+
+# oreblocks
+
+[![CI](https://img.shields.io/github/actions/workflow/status/fsantibanezleal/CAOS_OreBlocks/ci.yml?branch=main&label=CI)](https://github.com/fsantibanezleal/CAOS_OreBlocks/actions)
+[![License](https://img.shields.io/github/license/fsantibanezleal/CAOS_OreBlocks)](LICENSE)
+[![Version](https://img.shields.io/github/v/tag/fsantibanezleal/CAOS_OreBlocks?label=version&sort=semver)](https://github.com/fsantibanezleal/CAOS_OreBlocks/tags)
+
+**Synthetic 3-D ore-body block models of the MineLib nature** — seeded deposit archetypes with
+per-block grades, bench (level) structure, slope precedence, UPIT economics with per-block optimal
+destination, an **exact max-closure solver**, extraction states with **loading faces**, and MineLib
+`.blocks/.prec/.upit` **read/write**. Deterministic given a seed; every generated instance is
+clearly labelled SYNTHETIC.
+
+Why: per-block ground truth on real mines is licensed or proprietary (MineLib grants academic
+download only, no redistribution). oreblocks generates instances of the same *nature* — 3-D
+benches, grades, precedence, net values — with a **stamped exact optimum**, so solvers, dispatch
+simulators and teaching apps get license-free realistic instances with known-by-construction
+answers.
+
+## Install
+
+```bash
+pip install oreblocks
+```
+
+## Quickstart — a MineLib-format twin with a stamped optimum
+
+```python
+from oreblocks import make_twin
+
+twin = make_twin("porphyry", dims=(20, 20, 10), seed=42)
+print(twin.upit.pit_value, twin.upit.n_in_pit)   # the EXACT optimum, stamped
+twin.write("out/")   # -> twin-*.blocks / .prec / .upit / .meta.json (MineLib format)
+```
+
+The emitted triplet is byte-consumable by any MineLib UPIT reader. Cross-validated against an
+independent TypeScript min-cut engine (CAOS PitForge, which reproduces the published newman1 /
+zuck_small / kd optima): relative disagreement ~1e-11 on a 4,000-block twin.
+
+## Pieces
+
+| Module | What |
+|---|---|
+| `BlockGrid` | regular grid; LEVELS increase upward (the MineLib convention) |
+| `make_deposit` | seeded archetypes: `porphyry`, `vein`, `layered`, `core_halo` (trend + correlated noise) |
+| `Econ` / `block_values` | UPIT net value at the optimal destination (floating cutoff = the max) |
+| `build_precedence` | slope-cone template one level up (45° cubic → the classic 9-point), CSR |
+| `solve_upit` | exact Picard max-closure → Dinic min-cut; closure + value-identity self-checks |
+| `extraction_state` / `loading_faces` | top-down bench extraction + seeded k-means shovel faces (grade at face, ore fraction, tonnes) — the bridge to haulage simulators |
+| `write_minelib` / `read_*` | the `.blocks/.prec/.upit` triplet + a meta sidecar with the stamped optimum |
+
+## Convention notes
+
+- Levels (z) increase **upward**: level 0 is the deepest bench — exactly how published MineLib
+  instances index (verified against newman1). Depth-down viewers flip with `z_down = nz-1-level`.
+- `.blocks` free columns written by oreblocks are documented in the meta sidecar:
+  `grade (mass fraction) · tonnage (t) · density (t/m³)`.
+- Nothing here downloads or redistributes published MineLib data.
+
+## Used by
+
+- **minehaulsim** (haulage DES) — geology-grounded scenarios: loading faces with grade/bench.
+- **CAOS PitForge** — license-free synthetic twins next to the published-instance lane.
+
+## License
+
+Apache-2.0.

oreblocks-0.1.0/README.md

@@ -0,0 +1,66 @@
+# oreblocks
+
+[![CI](https://img.shields.io/github/actions/workflow/status/fsantibanezleal/CAOS_OreBlocks/ci.yml?branch=main&label=CI)](https://github.com/fsantibanezleal/CAOS_OreBlocks/actions)
+[![License](https://img.shields.io/github/license/fsantibanezleal/CAOS_OreBlocks)](LICENSE)
+[![Version](https://img.shields.io/github/v/tag/fsantibanezleal/CAOS_OreBlocks?label=version&sort=semver)](https://github.com/fsantibanezleal/CAOS_OreBlocks/tags)
+
+**Synthetic 3-D ore-body block models of the MineLib nature** — seeded deposit archetypes with
+per-block grades, bench (level) structure, slope precedence, UPIT economics with per-block optimal
+destination, an **exact max-closure solver**, extraction states with **loading faces**, and MineLib
+`.blocks/.prec/.upit` **read/write**. Deterministic given a seed; every generated instance is
+clearly labelled SYNTHETIC.
+
+Why: per-block ground truth on real mines is licensed or proprietary (MineLib grants academic
+download only, no redistribution). oreblocks generates instances of the same *nature* — 3-D
+benches, grades, precedence, net values — with a **stamped exact optimum**, so solvers, dispatch
+simulators and teaching apps get license-free realistic instances with known-by-construction
+answers.
+
+## Install
+
+```bash
+pip install oreblocks
+```
+
+## Quickstart — a MineLib-format twin with a stamped optimum
+
+```python
+from oreblocks import make_twin
+
+twin = make_twin("porphyry", dims=(20, 20, 10), seed=42)
+print(twin.upit.pit_value, twin.upit.n_in_pit)   # the EXACT optimum, stamped
+twin.write("out/")   # -> twin-*.blocks / .prec / .upit / .meta.json (MineLib format)
+```
+
+The emitted triplet is byte-consumable by any MineLib UPIT reader. Cross-validated against an
+independent TypeScript min-cut engine (CAOS PitForge, which reproduces the published newman1 /
+zuck_small / kd optima): relative disagreement ~1e-11 on a 4,000-block twin.
+
+## Pieces
+
+| Module | What |
+|---|---|
+| `BlockGrid` | regular grid; LEVELS increase upward (the MineLib convention) |
+| `make_deposit` | seeded archetypes: `porphyry`, `vein`, `layered`, `core_halo` (trend + correlated noise) |
+| `Econ` / `block_values` | UPIT net value at the optimal destination (floating cutoff = the max) |
+| `build_precedence` | slope-cone template one level up (45° cubic → the classic 9-point), CSR |
+| `solve_upit` | exact Picard max-closure → Dinic min-cut; closure + value-identity self-checks |
+| `extraction_state` / `loading_faces` | top-down bench extraction + seeded k-means shovel faces (grade at face, ore fraction, tonnes) — the bridge to haulage simulators |
+| `write_minelib` / `read_*` | the `.blocks/.prec/.upit` triplet + a meta sidecar with the stamped optimum |
+
+## Convention notes
+
+- Levels (z) increase **upward**: level 0 is the deepest bench — exactly how published MineLib
+  instances index (verified against newman1). Depth-down viewers flip with `z_down = nz-1-level`.
+- `.blocks` free columns written by oreblocks are documented in the meta sidecar:
+  `grade (mass fraction) · tonnage (t) · density (t/m³)`.
+- Nothing here downloads or redistributes published MineLib data.
+
+## Used by
+
+- **minehaulsim** (haulage DES) — geology-grounded scenarios: loading faces with grade/bench.
+- **CAOS PitForge** — license-free synthetic twins next to the published-instance lane.
+
+## License
+
+Apache-2.0.

oreblocks-0.1.0/pyproject.toml

@@ -0,0 +1,43 @@
+[project]
+name = "oreblocks"
+version = "0.1.0"
+description = "Synthetic 3D ore-body block models of the MineLib nature: seeded deposit archetypes, bench structure, slope precedence, UPIT economics, an exact max-closure solver, extraction states with loading faces, and MineLib .blocks/.prec/.upit read/write"
+readme = "README.md"
+requires-python = ">=3.11"
+license = { text = "Apache-2.0" }
+authors = [{ name = "Felipe Santibanez-Leal" }]
+keywords = ["mining", "block-model", "ore-body", "ultimate-pit", "UPIT", "MineLib", "open-pit", "mine-planning", "max-closure", "synthetic-data"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "License :: OSI Approved :: Apache Software License",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Scientific/Engineering",
+]
+dependencies = ["numpy>=1.26"]
+
+[project.urls]
+Repository = "https://github.com/fsantibanezleal/CAOS_OreBlocks"
+Changelog = "https://github.com/fsantibanezleal/CAOS_OreBlocks/blob/main/CHANGELOG.md"
+Issues = "https://github.com/fsantibanezleal/CAOS_OreBlocks/issues"
+
+[project.optional-dependencies]
+dev = ["pytest>=8", "ruff>=0.4"]
+
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.ruff]
+line-length = 118
+target-version = "py311"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "N", "UP", "B", "SIM"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

oreblocks-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

oreblocks-0.1.0/src/oreblocks/__init__.py

@@ -0,0 +1,46 @@
+"""oreblocks — synthetic 3-D ore-body block models of the MineLib nature.
+
+Seeded deposit archetypes with per-block grades, bench (level) structure, slope precedence, UPIT
+economics with per-block optimal destination, an exact max-closure solver, extraction states with
+loading faces, and MineLib ``.blocks/.prec/.upit`` read/write. Everything deterministic given a
+seed; every generated instance is clearly labelled SYNTHETIC.
+"""
+
+__version__ = "0.1.0"
+
+from .economics import Econ, block_values, cutoff_grade, is_ore
+from .extraction import ExtractionState, Face, extraction_state, loading_faces
+from .fields import ARCHETYPES, Deposit, make_deposit
+from .grid import BlockGrid
+from .minelib_io import read_blocks, read_meta, read_prec, read_upit, write_minelib
+from .precedence import Precedence, build_precedence, slope_offsets
+from .twins import Twin, make_twin
+from .upit import UpitResult, solve_upit
+
+__all__ = [
+    "__version__",
+    "ARCHETYPES",
+    "BlockGrid",
+    "Deposit",
+    "Econ",
+    "ExtractionState",
+    "Face",
+    "Precedence",
+    "Twin",
+    "UpitResult",
+    "block_values",
+    "build_precedence",
+    "cutoff_grade",
+    "extraction_state",
+    "is_ore",
+    "loading_faces",
+    "make_deposit",
+    "make_twin",
+    "read_blocks",
+    "read_meta",
+    "read_prec",
+    "read_upit",
+    "slope_offsets",
+    "solve_upit",
+    "write_minelib",
+]

oreblocks-0.1.0/src/oreblocks/_rng.py

@@ -0,0 +1,20 @@
+"""Seeded, named random streams — same discipline as minehaulsim.
+
+Every stochastic component draws from its own named stream derived from (seed, name), so adding a
+new consumer never perturbs existing draws and results are byte-identical given the seed.
+"""
+
+from __future__ import annotations
+
+import hashlib
+
+import numpy as np
+
+__all__ = ["stream"]
+
+
+def stream(seed: int, name: str) -> np.random.Generator:
+    """A generator for the (seed, name) pair — stable across platforms and numpy versions."""
+    digest = hashlib.sha256(f"{seed}:{name}".encode()).digest()
+    words = [int.from_bytes(digest[k : k + 4], "little") for k in range(0, 16, 4)]
+    return np.random.Generator(np.random.PCG64(np.random.SeedSequence(words)))

oreblocks-0.1.0/src/oreblocks/economics.py

@@ -0,0 +1,54 @@
+"""Block economics — the UPIT value model with per-block optimal destination.
+
+A block's net value is the better of its two destinations, exactly the semantics of a MineLib
+``.upit`` column (verified against newman1, where the published net value equals
+max(value-if-wasted, value-if-processed)):
+
+- waste:   ``-mining_cost * tonnage``
+- ore:     ``(grade * recovery * price - processing_cost) * tonnage - mining_cost * tonnage``
+
+The floating cutoff falls out of the max: a block is ore iff processing it beats wasting it.
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+import numpy as np
+
+from .fields import Deposit
+
+__all__ = ["Econ", "block_values", "is_ore", "cutoff_grade"]
+
+
+@dataclass(frozen=True)
+class Econ:
+    """price: $/t of recovered metal · recovery: 0..1 · costs: $/t mined / $/t milled."""
+
+    price: float = 9000.0
+    recovery: float = 0.88
+    mining_cost: float = 2.5
+    processing_cost: float = 9.0
+
+    def __post_init__(self) -> None:
+        if not (0 < self.recovery <= 1):
+            raise ValueError(f"recovery must be in (0,1], got {self.recovery}")
+        if self.price <= 0 or self.mining_cost < 0 or self.processing_cost < 0:
+            raise ValueError("price must be positive; costs non-negative")
+
+
+def cutoff_grade(econ: Econ) -> float:
+    """The grade above which processing beats wasting: processing_cost / (recovery * price)."""
+    return econ.processing_cost / (econ.recovery * econ.price)
+
+
+def block_values(dep: Deposit, econ: Econ) -> np.ndarray:
+    """Net value per block (float64) at the optimal destination — the ``.upit`` column."""
+    waste = -econ.mining_cost * dep.tonnage
+    ore = (dep.grade * econ.recovery * econ.price - econ.processing_cost) * dep.tonnage + waste
+    return np.maximum(waste, ore)
+
+
+def is_ore(dep: Deposit, econ: Econ) -> np.ndarray:
+    """Boolean per block: does processing beat wasting?"""
+    return dep.grade > cutoff_grade(econ)