Metadata-Version: 2.4
Name: mcdc
Version: 1.2.0.dev20260220
Summary: MC/DC (Monte Carlo Dynamic Code): a performant, scalable, and machine-portable Python-based Monte Carlo neutron transport package
Project-URL: Homepage, https://cement-psaap.github.io/
Project-URL: Repository, https://github.com/CEMeNT-PSAAP/MCDC
Project-URL: Documentation, https://mcdc.readthedocs.io/en/dev/
Project-URL: Issues, https://github.com/CEMeNT-PSAAP/MCDC/issues
Author: Caleb Shaw, Rohan Pankaj, Alexander Mote, Ethan Lame, Benjamin Whewell, Ryan G. McClarren, Todd S. Palmer, Lizhong Chen, Dmitriy Y. Anistratov, C. T. Kelley, Camille J. Palmer, Kyle E. Niemeyer
Author-email: Ilham Variansyah <variansi@oregonstate.edu>, Sam Pasmann <spasmann@nd.edu>, Joanna Morgan <morgan83@llnl.gov>, Kayla Clements <clemekay@oregonstate.edu>, Braxton Cuneo <bcuneo@seattleu.edu>
Maintainer-email: Ilham Variansyah <variansi@oregonstate.edu>, Braxton Cuneo <bcuneo@seattleu.edu>, Kayla Clements <clemekay@oregonstate.edu>, Joanna Piper Morgan <morgan83@llnl.gov>, "Kyle E. Niemeyer" <kyle.niemeyer@oregonstate.edu>
License: BSD 3-Clause License
        
        Copyright (c) 2021, CEMeNT
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: LICENSE
Keywords: GPU,HPC,Monte Carlo,mpi4py,neutron transport,nuclear engineering,numba
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3
Classifier: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: colorama
Requires-Dist: h5py
Requires-Dist: matplotlib
Requires-Dist: mpi4py>=3.1.4
Requires-Dist: numba>=0.60.0
Requires-Dist: numpy>=2.0.0
Requires-Dist: scipy
Requires-Dist: sympy
Provides-Extra: dev
Requires-Dist: black; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Provides-Extra: docs
Requires-Dist: furo; extra == 'docs'
Requires-Dist: sphinx-toolbox; extra == 'docs'
Requires-Dist: sphinx==7.2.6; extra == 'docs'
Description-Content-Type: text/markdown

# MC/DC: Monte Carlo Dynamic Code

![mcdc_logo v1](https://user-images.githubusercontent.com/26186244/173467190-74d9b09a-ef7d-4f0e-8bdf-4a076de7c43c.svg)

[![Build](https://github.com/CEMeNT-PSAAP/MCDC/actions/workflows/regression_test.yml/badge.svg)](https://github.com/CEMeNT-PSAAP/MCDC/actions/workflows/regression_test.yml)
[![DOI](https://joss.theoj.org/papers/10.21105/joss.06415/status.svg)](https://doi.org/10.21105/joss.06415)
[![ReadTheDocs](https://github.com/CEMeNT-PSAAP/MCDC/actions/workflows/docs_test.yml/badge.svg)](https://mcdc.readthedocs.org/en/dev/ )
[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)

MC/DC is a performant, scalable, and machine-portable Python-based Monte Carlo 
neutron transport software, initiated by the Center for Exascale Monte Carlo 
Neutron Transport ([CEMeNT](https://cement-psaap.github.io/)), and currently 
in active development in the Center for Advancing the Radiation Resilience of 
Electronics ([CARRE](https://carre-psaapiv.org)).

## Documentation

All detailed instructions and guides are hosted on [Read the Docs](https://mcdc.readthedocs.io/en/dev/). These include:
- [Installation](https://mcdc.readthedocs.io/en/dev/install.html),
- [User Guide](https://mcdc.readthedocs.io/en/dev/user/index.html),
- [API Reference](https://mcdc.readthedocs.io/en/dev/pythonapi/index.html), and
- [Contribution Guide](https://mcdc.readthedocs.io/en/dev/contribution/index.html).

## Citing

If you use MC/DC in your work and want to provide attribution, please cite the following as appropriate:
- **[MC/DC Origins]** I. Variansyah, et al. (2023). Development of MC/DC: a performant, scalable, and portable Python-based Monte Carlo neutron transport code. Proc. ANS M&C 2025, Niagara Falls, Canada. https://doi.org/10.48550/arXiv.2305.07636.
- **[MC/DC JOSS article]** J. Morgan, et al. (2024). Monte Carlo / Dynamic Code (MC/DC): An accelerated Python package for fully transient neutron transport and rapid methods development. Journal of Open Source Software, 9(96), 6415. https://doi.org/10.21105/joss.06415.

## Reporting Bugs and Issues

To report bugs or request new features, feel free to [open an Issue](https://github.com/CEMeNT-PSAAP/MCDC/issues).
