Morana

Morana (MOdern Reactor ANAlysis) is a Python package for finite-volume neutron-diffusion calculations on regular hex-z lattices. It is a transparent reference implementation for research, teaching, and numerical-method development. The package import name is morana.

Read the published documentation for installation, modeling guidance, examples, verification evidence, and the Python API reference.

Morana supports one-group and multigroup fixed-source and k_eff calculations on variable-height hex-z material meshes. See the documentation home for a concise capability overview and the modeling and solver workflow for the supported workflow and capability limits.

Project status

Morana is intended for research, teaching, and software development. It has not been validated against experimental reactor measurements or qualified for design, operational, licensing, or regulatory decisions. Results must be independently reviewed and validated for their intended use. Example cross sections are illustrative and are not reactor-design data. See verification and comparisons for the evidence and its limitations.

Morana is also in early development: its public Python API may change incompatibly without a backward-compatibility guarantee. Record the exact source commit and dependency environment for reproducible work, and review the API stability policy and changelog before upgrading.

Morana 0.1.0 is its first public release; development before this release occurred in a private repository, so the public Git history begins with version 0.1.0.

Development disclosure

Generative-AI coding tools assist Morana development. Project maintainers remain responsible for design decisions, review, testing, documentation, and released code. This disclosure does not alter the Apache-2.0 license or its warranty disclaimer; it records the maintainers' responsibility for reviewing and releasing AI-assisted contributions.

Installation

Morana requires Python 3.12 or newer. Version 0.2.0 is available as a package distribution from PyPI, as a source release from GitHub, and from Zenodo under DOI 10.5281/zenodo.23118502. Install the exact release into an isolated environment:

python -m venv .venv
source .venv/bin/activate
python -m pip install "morana==0.2.0"

Follow installation and quickstart for platform requirements, the WSL option for Windows users, and a first analytic problem. Contributors should use the documented Conda development environment. The maintained examples demonstrate the supported solver, boundary, geometry, and output workflows.

Documentation

• Start: installation and quickstart and maintained examples
• Understand: geometry and indexing, theory and numerical conventions, and inspection and output
• Build and solve: modeling and solver workflow, boundary conditions and face selection, and source-derived Python reference
• Evaluate and contribute: verification and comparisons, changelog, and contributor workflow

The contributor workflow explains how to build and preview the complete documentation locally. The Markdown sources remain available in the repository's docs/ directory.

Citation

Machine-readable citation metadata is provided in CITATION.cff. The version DOI for Morana 0.2.0 is 10.5281/zenodo.23118502. For project-level citation across releases, use the concept DOI 10.5281/zenodo.22681315. This all-versions DOI follows the latest release; use the version DOI to identify the exact archived source used in a calculation.

License

Morana source code and authored documentation are licensed under Apache-2.0 and provided without warranties or conditions beyond those stated in the license. The documentation site includes third-party notices for its distributed frontend assets.