Metadata-Version: 2.4
Name: ramp-coremaker
Version: 0.0.4
Summary: Package for representation of geometric and material compositions of nuclear reactor components
Author-email: Nuclear RAMP team <nuclear.ramp.dev@gmail.com>
License-Expression: MIT
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Topic :: Scientific/Engineering
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: scipy
Requires-Dist: numpy
Requires-Dist: cytoolz
Requires-Dist: pyparsing
Requires-Dist: more-itertools
Requires-Dist: multipledispatch
Requires-Dist: ramp-core
Requires-Dist: ramp-isotopes
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-regressions; extra == "test"
Requires-Dist: hypothesis; extra == "test"
Dynamic: license-file

# Core Maker
The CoreMaker package is a nuclear reactor core modelling package.
This package aims to make it easy for researchers to create reproducible, interoperable
descriptions of nuclear reactor cores.

This package is developed as part of the Reactor Analysis Management Program project,
where it is used for defining the concepts of a nuclear core and implementations of
various geometries and materials.

To understand the core concepts of this package, please check out our documentation.
Building the documentation is done by writing "make html" in the `docs` folder once
all the requirements are installed.

## How to Contribute
Our documentation is probably where we have the most to gain from new contributors.
Please feel free to read through it, ask questions and help us make it a better tool for
beginners.

Users who want support for additional `Surfaces`, `Geometries` or `Constructions`
are welcome to suggest and contribute new models.
If you can send us the use case for core components where such tools are necessary,
we will gladly consider your contribution.

Another relatively good place to start is with writing tests.
Our test coverage could still be better, and writing tests is a good way to make yourself
familir with our API.

For more experienced developers, one of our main next goals is to support a human readable
serialization of our models.
