Fix project issue #1
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit implements the full pyT5 package as specified in specs_pyT5.md, a Python interface for Tripoli-5 Monte-Carlo code for PWR reactor modeling. Key features implemented: - Complete object-oriented architecture with 11 core classes - Nuclear data management (NuclearData) - Material and cell definition (Material, MaterialLibrary, Cell, CellLibrary) - Geometry classes (PinCell, Assembly, Colorset, Core, Reflector) - Source and media (NeutronSource, NeutronMedia) - Visualization and scoring (Visualization, Score, ScoreLibrary) - Simulation control and execution (Simulation) - Remote computing support (RemoteCompute) - Results retrieval and analysis (Results) Best practices implemented: - Modern src-layout package structure - Comprehensive type hints throughout (mypy compliant) - Full docstrings for all classes and methods - Complete test suite with pytest (fixtures and unit tests) - Linting configuration (ruff, mypy) - CI/CD workflow with GitHub Actions - Comprehensive README with usage examples - Example scripts for pin cells and assemblies - Documentation structure Package configuration: - pyproject.toml with all metadata and dependencies - .gitignore for Python projects - MIT License - MANIFEST.in for package data - py.typed marker for type checking support The package is fully installable, testable, and follows Python packaging best practices.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit implements the full pyT5 package as specified in specs_pyT5.md, a Python interface for Tripoli-5 Monte-Carlo code for PWR reactor modeling.
Key features implemented:
Best practices implemented:
Package configuration:
The package is fully installable, testable, and follows Python packaging best practices.