gitronics 0.5.4__tar.gz → 0.5.6__tar.gz

{gitronics-0.5.4 → gitronics-0.5.6}/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,10 +390,11 @@ dependencies = [
 
 [[package]]
 name = "gitronics"
-version = "0.5.4"
+version = "0.5.6"
 dependencies = [
  "chrono",
  "clap",
+ "dunce",
  "env_logger",
  "git2",
  "indexmap",

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

@@ -1,9 +1,10 @@
 [package]
 name = "gitronics"
-version = "0.5.4"
+version = "0.5.6"
 edition = "2024"
 description = "Build MCNP neutronics models from modular components"
 license = "EUPL-1.2"
+readme = "README.md"
 
 [[bin]]
 name = "gitronics"
@@ -28,6 +29,7 @@ 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"

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

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

gitronics-0.5.6/README.md

@@ -0,0 +1,103 @@
+<div align="center">
+  <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>
+
+  [![CI](https://github.com/Fusion4Energy/gitronics/actions/workflows/ci.yml/badge.svg)](https://github.com/Fusion4Energy/gitronics/actions/workflows/ci.yml)
+  [![Docs](https://github.com/Fusion4Energy/gitronics/actions/workflows/docs.yml/badge.svg)](https://fusion4energy.github.io/gitronics/latest/)
+  [![PyPI](https://img.shields.io/pypi/v/gitronics)](https://pypi.org/project/gitronics/)
+  [![License: EUPL-1.2](https://img.shields.io/badge/License-EUPL--1.2-blue.svg)](LICENSE)
+</div>
+
+---
+
+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/)**
+
+## Why?
+
+| Problem with monolithic models | Gitronics solution |
+|---|---|
+| `git diff` is unreadable | Each component is a separate file |
+| Running variants means copying the whole file | Override only the fields that change |
+| Teams can't work on sub-models in parallel | Each filler model is independent |
+| Hard to know exactly what was run | Commit hash and timestamp written into every assembled file |
+
+## Installation
+
+```bash
+pip install gitronics
+```
+
+Requires Python 3.9+. Pre-built wheels for Linux, macOS, and Windows are published to PyPI — no Rust toolchain needed.
+
+## Quick start
+
+**Migrate an existing model:**
+
+```bash
+gitronics migrate path/to/my_model.mcnp --output-path ./my_project
+```
+
+**Build a model:**
+
+```bash
+gitronics build my_project/configurations/baseline.yaml --output-path my_project/output/
+```
+
+**Get help:**
+
+```bash
+gitronics --help
+gitronics build --help
+gitronics migrate --help
+```
+
+## Project layout
+
+```
+my_project/
+├── configurations/
+│   ├── baseline.yaml          ← declares which fillers go where
+│   └── variant_A.yaml         ← inherits baseline, overrides some fields
+├── output/
+│   └── .gitignore
+└── reference_model/
+    ├── envelope_structure.mcnp
+    ├── filler_models/
+    │   ├── component_A.mcnp
+    │   └── component_B.mcnp
+    └── data_cards/
+        ├── materials/
+        ├── sources/
+        └── tallies/
+```
+
+## Configuration example
+
+```yaml
+project_roots: [..]  # Relative to this file's location
+
+envelope_structure: envelope_structure
+source: dt_plasma
+materials: [all_materials]
+tallies: [tritium_breeding_ratio]
+
+envelopes:
+  blanket_inner: blanket_v3
+  blanket_outer: blanket_reference
+  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.
+
+## Documentation
+
+The full documentation covers installation, CLI reference, configuration options, best practices, and worked examples:
+
+**[fusion4energy.github.io/gitronics](https://fusion4energy.github.io/gitronics/latest/)**
+
+## License
+
+[EUPL-1.2](LICENSE)

{gitronics-0.5.4 → gitronics-0.5.6}/mkdocs.yml

@@ -1,14 +1,14 @@
 site_name: Gitronics
 site_description: Build MCNP neutronics models from modular components
-site_url: https://gitronics.github.io/gitronics # TODO: update with your GitHub username/org
-repo_url: https://github.com/gitronics/gitronics # TODO: update with your GitHub username/org
-repo_name: gitronics/gitronics
+site_url: https://fusion4energy.github.io/gitronics/latest/
+repo_url: https://github.com/Fusion4Energy/gitronics
+repo_name: Fusion4Energy/gitronics
 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.4 → gitronics-0.5.6}/src/build_model.rs

@@ -1,10 +1,10 @@
 use crate::project_manager::ProjectManager;
-use crate::types::{AssembledMetadata, CellId, EnvelopeName, FillerName, UniverseId};
+use crate::types::{CellId, EnvelopeName, FillerName, UniverseId};
 use crate::utils::GitronicsError;
 
 use git2::Repository;
 use log::{info, warn};
-use migjorn::{Card, CellParam, DataCard, Model, ParamType};
+use migjorn::{Card, CellCard, CellParam, DataCard, Model, ParamType};
 use regex::Regex;
 use std::{collections::HashMap, path::Path, sync::LazyLock};
 use std::{env, fs};
@@ -63,8 +63,8 @@ pub fn build_model(config_path: &Path, output_path: &Path) -> Result<(), Gitroni
 
     // Write model
     let assembled_path = project_manager.output_path().join("assembled.mcnp");
+    write_assembled_header(&mut envelope_structure, config_path)?;
     envelope_structure.write_to_file(&assembled_path)?;
-    write_assembled_metadata(&project_manager, config_path)?;
     fs::write(output_path.join(".gitignore"), "*\n")?;
 
     info!(
@@ -168,25 +168,37 @@ fn get_universe_id_of_model(model: &Model) -> Result<UniverseId, GitronicsError>
         .ok_or_else(|| GitronicsError::FirstCellWithoutUniverseID(FillerName::from(model)))
 }
 
-fn write_assembled_metadata(
-    project_manager: &ProjectManager,
+fn write_assembled_header(
+    assembled_model: &mut Model,
     config_path: &Path,
 ) -> Result<(), GitronicsError> {
     let configuration = config_path.display().to_string();
     let date_time = chrono::Utc::now().format("%Y-%m-%d %H:%M:%S").to_string();
     let gitronics_version = env!("CARGO_PKG_VERSION");
     let commit_hash = get_hash_of_project();
-    let assembled_metadata = AssembledMetadata {
-        configuration,
-        date_time,
-        gitronics_version: gitronics_version.to_string(),
-        git_commit_hash: commit_hash,
-    };
-    let metadata_path = project_manager.output_path().join("assembled.metadata");
-    let yaml_content = serde_saphyr::to_string(&assembled_metadata).map_err(|e| {
-        GitronicsError::YamlSerialize(metadata_path.display().to_string(), e.to_string())
-    })?;
-    fs::write(&metadata_path, yaml_content)?;
+
+    let banner = format!(
+        "C ============================================================
+C  Built by gitronics v{gitronics_version}
+C  Configuration : {configuration}
+C  Git commit    : {commit_hash}
+C  Date / time   : {date_time}
+C ============================================================"
+    );
+    let new_card_text = format!(
+        "{banner}\n{}",
+        assembled_model
+            .cells
+            .first()
+            .map(|c| c.original_text())
+            .unwrap_or_default()
+    );
+
+    let banner_card = CellCard::try_from(new_card_text.as_str())
+        .expect("Adding comments as header should not fail");
+
+    // Replace the first cell (previously a comment placeholder) with the banner card
+    assembled_model.cells[0] = banner_card;
     Ok(())
 }
 

{gitronics-0.5.4 → gitronics-0.5.6}/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;
@@ -102,7 +102,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.4 → gitronics-0.5.6}/src/types.rs

@@ -11,15 +11,6 @@ use indexmap::IndexMap;
 use migjorn::Model;
 use serde::{Deserialize, Serialize};
 
-/// Metadata associated with an assembled model
-#[derive(Debug, Serialize, Deserialize)]
-pub struct AssembledMetadata {
-    pub configuration: String,
-    pub date_time: String,
-    pub gitronics_version: String,
-    pub git_commit_hash: String,
-}
-
 /// Metadata associated with a filler model, describing how it should be placed.
 #[derive(Debug, Serialize, Deserialize)]
 pub struct FillerMetadata {