gitronics 0.5.6__tar.gz → 0.5.8__tar.gz

gitronics-0.5.8/.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+    "python-envs.defaultEnvManager": "ms-python.python:conda",
+    "python-envs.defaultPackageManager": "ms-python.python:conda"
+}

{gitronics-0.5.6 → gitronics-0.5.8}/Cargo.lock

@@ -390,7 +390,7 @@ dependencies = [
 
 [[package]]
 name = "gitronics"
-version = "0.5.6"
+version = "0.5.8"
 dependencies = [
  "chrono",
  "clap",
@@ -399,6 +399,7 @@ dependencies = [
  "git2",
  "indexmap",
  "log",
+ "logtest",
  "migjorn",
  "pyo3",
  "rayon",
@@ -550,6 +551,12 @@ dependencies = [
  "wasm-bindgen",
 ]
 
+[[package]]
+name = "lazy_static"
+version = "1.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "bbd2bcb4c963f2ddae06a2efc7e9f3591312473c50c6685e1f298068316e66fe"
+
 [[package]]
 name = "leb128fmt"
 version = "0.1.0"
@@ -597,6 +604,19 @@ name = "log"
 version = "0.4.29"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "5e5032e24019045c762d3c0f28f5b6b8bbf38563a65908389bf7978758920897"
+dependencies = [
+ "value-bag",
+]
+
+[[package]]
+name = "logtest"
+version = "2.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "eb3e43a8657c1d64516dcc9db8ca03826a4aceaf89d5ce1b37b59f6ff0e43026"
+dependencies = [
+ "lazy_static",
+ "log",
+]
 
 [[package]]
 name = "memchr"
@@ -1031,6 +1051,12 @@ version = "0.2.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821"
 
+[[package]]
+name = "value-bag"
+version = "1.12.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7ba6f5989077681266825251a52748b8c1d8a4ad098cc37e440103d0ea717fc0"
+
 [[package]]
 name = "vcpkg"
 version = "0.2.15"

{gitronics-0.5.6 → gitronics-0.5.8}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "gitronics"
-version = "0.5.6"
+version = "0.5.8"
 edition = "2024"
 description = "Build MCNP neutronics models from modular components"
 license = "EUPL-1.2"
@@ -33,3 +33,4 @@ dunce = "1.0.5"
 
 [dev-dependencies]
 tempfile = "3.0"
+logtest = "2.0"

{gitronics-0.5.6 → gitronics-0.5.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitronics
-Version: 0.5.6
+Version: 0.5.8
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy

{gitronics-0.5.6 → gitronics-0.5.8}/docs/usage/build.md

@@ -42,6 +42,26 @@ C ============================================================
 
 Gitronics searches all directories listed in `project_roots` (defined in the configuration) for files referenced by stem name. Any file whose stem (name without extension) matches a key in the configuration is a candidate. This means you can organise your project files into subdirectories however you like, as long as each stem name is unique across all `project_roots`.
 
+## Python API
+
+`build_model` is also available as a Python function for use in scripts and notebooks:
+
+```python
+import gitronics
+
+gitronics.build_model(
+    "configurations/in_vessel_only.yaml",
+    "output/",
+)
+```
+
+| Parameter | Type | Description |
+|---|---|---|
+| `config_path` | `str` or `Path` | Path to the configuration YAML file. |
+| `output_path` | `str` or `Path` | Directory to write `assembled.mcnp` into. |
+
+Raises `RuntimeError` on failure with a descriptive message.
+
 ## Logging
 
 Set the `RUST_LOG` environment variable to control verbosity:

{gitronics-0.5.6 → gitronics-0.5.8}/python/gitronics/__init__.py

@@ -10,9 +10,10 @@ from __future__ import annotations
 
 import sys
 
+from .gitronics import py_build_model as build_model  # type: ignore[import]
 from .gitronics import run  # type: ignore[import]
 
-__all__ = ["run"]
+__all__ = ["build_model", "run"]
 
 
 def _cli_main() -> None:

gitronics-0.5.8/python/gitronics/__main__.py

@@ -0,0 +1,3 @@
+from gitronics import _cli_main
+
+_cli_main()

gitronics-0.5.8/python/gitronics/gitronics.pyi

@@ -0,0 +1,45 @@
+"""Type stubs for the gitronics Rust extension module."""
+
+from pathlib import Path
+
+def run(args: list[str]) -> None:
+    """Run the gitronics CLI with the given argument list.
+
+    This is equivalent to running ``gitronics`` from the command line.
+    ``args[0]`` should be the program name (i.e. ``sys.argv``).
+
+    Args:
+        args: Argument list in ``sys.argv`` format, e.g.
+            ``["gitronics", "build", "config.yaml"]``.
+
+    Raises:
+        RuntimeError: If the command fails.
+    """
+    ...
+
+def py_build_model(config_path: Path | str, output_path: Path | str) -> None:
+    """Assemble an MCNP model from a gitronics configuration file.
+
+    Reads the YAML configuration at *config_path*, resolves all referenced
+    filler models and data-card files, and writes ``assembled.mcnp`` (plus a
+    ``.gitignore``) into *output_path*.
+
+    Args:
+        config_path: Path to the YAML configuration file.
+        output_path: Directory where ``assembled.mcnp`` will be written.
+            The directory must already exist.
+
+    Raises:
+        RuntimeError: If any step of the build fails (e.g. missing file,
+            invalid MCNP syntax, validation error).
+
+    Example::
+
+        import gitronics
+
+        gitronics.build_model(
+            "configurations/baseline.yaml",
+            "output/",
+        )
+    """
+    ...

gitronics-0.5.8/python/tests/test_build_model.py

@@ -0,0 +1,30 @@
+import tempfile
+from pathlib import Path
+
+import gitronics
+import pytest
+
+EXAMPLE_CONFIG = (
+    Path(__file__).parent.parent.parent
+    / "example_project"
+    / "configurations"
+    / "valid_configuration.yaml"
+)
+
+
+def test_build_model_success():
+    with tempfile.TemporaryDirectory() as output_dir:
+        gitronics.build_model(EXAMPLE_CONFIG, output_dir)
+        assert (Path(output_dir) / "assembled.mcnp").exists()
+
+
+def test_build_model_accepts_str_paths():
+    with tempfile.TemporaryDirectory() as output_dir:
+        gitronics.build_model(str(EXAMPLE_CONFIG), output_dir)
+        assert (Path(output_dir) / "assembled.mcnp").exists()
+
+
+def test_build_model_missing_config_raises():
+    with tempfile.TemporaryDirectory() as output_dir:
+        with pytest.raises(RuntimeError):
+            gitronics.build_model("does_not_exist.yaml", output_dir)

{gitronics-0.5.6 → gitronics-0.5.8}/src/build_model.rs

@@ -6,6 +6,7 @@ use git2::Repository;
 use log::{info, warn};
 use migjorn::{Card, CellCard, CellParam, DataCard, Model, ParamType};
 use regex::Regex;
+use std::collections::HashSet;
 use std::{collections::HashMap, path::Path, sync::LazyLock};
 use std::{env, fs};
 
@@ -82,6 +83,9 @@ fn add_fill_cards_to_envelopes(
     universe_ids: &HashMap<FillerName, UniverseId>,
     envelope_structure: &mut Model,
 ) -> Result<(), GitronicsError> {
+    let mut missing_envelopes_in_file: HashSet<EnvelopeName> =
+        project_manager.envelopes_in_config().cloned().collect();
+
     for cell in envelope_structure.cells.iter_mut() {
         let original_text = cell.original_text();
         let Some(caps) = ENVELOPE_RE.captures(original_text) else {
@@ -105,6 +109,9 @@ fn add_fill_cards_to_envelopes(
             continue;
         };
 
+        // Remove the envelope from the set of missing envelopes, as we have found it in the file
+        missing_envelopes_in_file.remove(&envelope_name);
+
         // Envelope explicitly set to null in config, so we skip it
         let Some(filler_name) = env_config.as_ref() else {
             continue;
@@ -129,6 +136,18 @@ fn add_fill_cards_to_envelopes(
                 .map_err(|e| GitronicsError::InvalidFillCard(fill_card_text, e.to_string()))?,
         );
     }
+
+    if !missing_envelopes_in_file.is_empty() {
+        warn!(
+            "The following envelopes were defined in the configuration file but not found in the envelope structure file: {}. \
+             Please check that the `$ @env:envelope_name` pattern is satisfied.",
+            missing_envelopes_in_file
+                .into_iter()
+                .map(|e| e.to_string())
+                .collect::<Vec<_>>()
+                .join(", ")
+        );
+    }
     Ok(())
 }
 

{gitronics-0.5.6 → gitronics-0.5.8}/src/project_manager.rs

@@ -85,6 +85,11 @@ impl ProjectManager {
             .get(envelope_name)
             .and_then(|opt| opt.as_deref()))
     }
+
+    /// Returns an iterator over the envelope names defined in the configuration.
+    pub fn envelopes_in_config(&self) -> impl Iterator<Item = &EnvelopeName> {
+        self.model_config.envelopes().keys()
+    }
 }
 
 /// Indexes project files using roots resolved from a loaded configuration.

gitronics-0.5.8/src/python.rs

@@ -0,0 +1,31 @@
+use std::path::PathBuf;
+
+use pyo3::prelude::*;
+
+use crate::build_model::build_model;
+use crate::run_cli;
+
+#[pyfunction]
+fn run(args: Vec<String>) -> PyResult<()> {
+    use pyo3::exceptions::PyRuntimeError;
+    // Clap exits the process on --help / bad args; that's acceptable.
+    run_cli(args).map_err(|e| PyRuntimeError::new_err(e.to_string()))
+}
+
+/// Build an MCNP model from a gitronics configuration file.
+///
+/// Args:
+///     config_path: Path to the YAML configuration file.
+///     output_path: Directory where the assembled model will be written.
+#[pyfunction]
+fn py_build_model(config_path: PathBuf, output_path: PathBuf) -> PyResult<()> {
+    use pyo3::exceptions::PyRuntimeError;
+    build_model(&config_path, &output_path).map_err(|e| PyRuntimeError::new_err(e.to_string()))
+}
+
+/// Python extension module.
+#[pymodule]
+fn gitronics(m: &Bound<'_, PyModule>) -> PyResult<()> {
+    m.add_function(wrap_pyfunction!(run, m)?)?;
+    m.add_function(wrap_pyfunction!(py_build_model, m)?)
+}

{gitronics-0.5.6 → gitronics-0.5.8}/tests/test_example_project.rs

@@ -1,4 +1,6 @@
 use gitronics::build_model;
+use log::Level;
+use logtest::Logger;
 use std::fs;
 use std::path::{Path, PathBuf};
 use tempfile::tempdir;
@@ -246,3 +248,42 @@ fn test_filler_first_cell_without_universe_id() {
     let msg = result.unwrap_err().to_string();
     assert!(msg.contains("No universe ID found in first cell of filler model"));
 }
+
+#[test]
+fn test_envelopes_in_config_that_dont_exist() {
+    let mut logger = Logger::start();
+    let dir = tempdir().unwrap();
+    let example_project_path = PathBuf::from("example_project/");
+    copy_dir(&example_project_path, dir.path()).unwrap();
+
+    fs::write(
+        dir.path().join("configurations/valid_configuration.yaml"),
+        "project_roots: [..]
+overrides: null
+
+envelope_structure: envelope_structure
+source: volumetric_source
+materials: [materials]
+transformations: [my_transform]
+tallies: [fine_mesh]
+envelopes:
+  my_envelope_name_1: filler_model_1
+  wrong_envelope_name: filler_model_2
+",
+    )
+    .unwrap();
+
+    build_model(
+        &dir.path().join("configurations/valid_configuration.yaml"),
+        dir.path().join("out").as_path(),
+    )
+    .unwrap();
+
+    let warn_message = "The following envelopes were defined in the configuration file but not found in the envelope structure file";
+
+    assert!(
+        logger.any(|record| {
+            record.level() == Level::Warn && record.args().contains(warn_message)
+        })
+    );
+}

gitronics-0.5.6/src/python.rs

@@ -1,16 +0,0 @@
-use pyo3::prelude::*;
-
-use crate::run_cli;
-
-#[pyfunction]
-fn run(args: Vec<String>) -> PyResult<()> {
-    use pyo3::exceptions::PyRuntimeError;
-    // Clap exits the process on --help / bad args; that's acceptable.
-    run_cli(args).map_err(|e| PyRuntimeError::new_err(e.to_string()))
-}
-
-/// Python extension module.
-#[pymodule]
-fn gitronics(m: &Bound<'_, PyModule>) -> PyResult<()> {
-    m.add_function(wrap_pyfunction!(run, m)?)
-}