gitronics 0.5.5__tar.gz → 0.5.7__tar.gz

{gitronics-0.5.5 → gitronics-0.5.7}/Cargo.lock

@@ -238,6 +238,12 @@ version = "0.8.21"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "d0a5c400df2834b80a4c3327b3aad3a4c4cd4de0629063962b03235697506a28"
 
+[[package]]
+name = "dunce"
+version = "1.0.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "92773504d58c093f6de2459af4af33faa518c13451eb8f2b5698ed3d36e7c813"
+
 [[package]]
 name = "either"
 version = "1.15.0"
@@ -384,14 +390,16 @@ dependencies = [
 
 [[package]]
 name = "gitronics"
-version = "0.5.5"
+version = "0.5.7"
 dependencies = [
  "chrono",
  "clap",
+ "dunce",
  "env_logger",
  "git2",
  "indexmap",
  "log",
+ "logtest",
  "migjorn",
  "pyo3",
  "rayon",
@@ -543,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"
@@ -590,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"
@@ -1024,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.5 → gitronics-0.5.7}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "gitronics"
-version = "0.5.5"
+version = "0.5.7"
 edition = "2024"
 description = "Build MCNP neutronics models from modular components"
 license = "EUPL-1.2"
@@ -29,6 +29,8 @@ regex = "1.12.3"
 clap = { version = "4.6.1", features = ["derive"] }
 indexmap = { version = "2.14.0", features = ["serde"] }
 git2 = "0.21.0"
+dunce = "1.0.5"
 
 [dev-dependencies]
 tempfile = "3.0"
+logtest = "2.0"

{gitronics-0.5.5 → gitronics-0.5.7}/PKG-INFO

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

{gitronics-0.5.5 → gitronics-0.5.7}/README.md

@@ -1,5 +1,5 @@
 <div align="center">
-  <img src="docs/logo.png" alt="Gitronics logo" width="140"/>
+  <img src="docs/assets/logo.png" alt="Gitronics logo" width="140"/>
   <h1>Gitronics</h1>
   <p><strong>Build MCNP neutronics models from modular, version-controlled components.</strong></p>
 
@@ -11,7 +11,7 @@
 
 ---
 
-Gitronics lets you decompose a monolithic **MCNP** input file into independent, version-controllable components — universe filler models, an envelope structure, and separate data cards — and reassemble them at build time via a YAML configuration.
+Gitronics lets you decompose a monolithic [MCNP](https://mcnp.lanl.gov/) input file into independent, version-controllable components — universe filler models, an envelope structure, and separate data cards — and reassemble them at build time via a YAML configuration.
 
 **Full documentation: [fusion4energy.github.io/gitronics](https://fusion4energy.github.io/gitronics/latest/)**
 
@@ -60,7 +60,7 @@ gitronics migrate --help
 my_project/
 ├── configurations/
 │   ├── baseline.yaml          ← declares which fillers go where
-│   └── variant_A.yaml         ← inherits baseline, overrides selected envelopes
+│   └── variant_A.yaml         ← inherits baseline, overrides some fields
 ├── output/
 │   └── .gitignore
 └── reference_model/
@@ -77,7 +77,7 @@ my_project/
 ## Configuration example
 
 ```yaml
-project_roots: [..]
+project_roots: [..]  # Relative to this file's location
 
 envelope_structure: envelope_structure
 source: dt_plasma
@@ -87,7 +87,7 @@ tallies: [tritium_breeding_ratio]
 envelopes:
   blanket_inner: blanket_v3
   blanket_outer: blanket_reference
-  divertor:      null           # void — no FILL card inserted
+  divertor: null  # void — no FILL card inserted
 ```
 
 Configurations support inheritance: a variant config can set `overrides: baseline.yaml` and override only the fields that differ.

{gitronics-0.5.5 → gitronics-0.5.7}/mkdocs.yml

@@ -7,8 +7,8 @@ edit_uri: edit/main/docs/
 
 theme:
   name: material
-  logo: logo.png
-  favicon: logo.png
+  logo: assets/logo.png
+  favicon: assets/logo.png
   palette:
     - scheme: default
       primary: deep purple

{gitronics-0.5.5 → gitronics-0.5.7}/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.5 → gitronics-0.5.7}/src/project_manager.rs

@@ -4,7 +4,7 @@ use crate::types::{EnvelopeName, FileName, FillerName};
 use crate::utils::{GitronicsError, get_file_paths};
 use std::collections::HashMap;
 use std::collections::hash_map::Entry;
-use std::fs::{self, create_dir_all};
+use std::fs::create_dir_all;
 use std::path::PathBuf;
 
 mod load_metadata;
@@ -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.
@@ -102,7 +107,7 @@ fn index_project_files(
                     return Err(GitronicsError::DuplicateFileName(entry.key().clone()));
                 }
                 Entry::Vacant(entry) => {
-                    entry.insert(fs::canonicalize(path)?);
+                    entry.insert(dunce::canonicalize(path)?);
                 }
             }
         }

{gitronics-0.5.5 → gitronics-0.5.7}/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.5/python/gitronics/__main__.py

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