Metadata-Version: 2.4
Name: mcdc
Version: 0.14.1
Summary: A performant, scalable, and machine-portable Monte Carlo radiation transport code.
Project-URL: Homepage, https://mcdc.readthedocs.io/
Project-URL: Documentation, https://mcdc.readthedocs.io/
Project-URL: Repository, https://github.com/mcdc-project/mcdc
Project-URL: Issues, https://github.com/mcdc-project/mcdc/issues
Project-URL: Release Notes, https://github.com/mcdc-project/mcdc/releases
Author: MC/DC Development Team
Maintainer-email: Ilham Variansyah <variansi@oregonstate.edu>, Joanna Piper Morgan <morgan83@llnl.gov>, Melek Derman <dermanm@oregonstate.edu>, Nathan Glaser <glaserna@oregonstate.edu>, Massimo Larsen <larsemas@oregonstate.edu>, Braxton Cuneo <bcuneo@seattleu.edu>, "Kyle E. Niemeyer" <kyle.niemeyer@oregonstate.edu>, Madicken Munk <madicken.munk@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,high-performance computing,hpc,monte carlo,mpi,neutron transport,numba,radiation transport
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
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

![MC/DC logo](https://raw.githubusercontent.com/mcdc-project/mcdc/main/assets/mcdc-logo.svg)

[![Build](https://github.com/mcdc-project/mcdc/actions/workflows/regression_test.yml/badge.svg)](https://github.com/mcdc-project/mcdc/actions/workflows/regression_test.yml)
[![Docker Build, Test, and Publish](https://github.com/mcdc-project/mcdc/actions/workflows/docker.yml/badge.svg)](https://github.com/mcdc-project/mcdc/actions/workflows/docker.yml)
[![Read the Docs](https://github.com/mcdc-project/mcdc/actions/workflows/docs_test.yml/badge.svg)](https://mcdc.readthedocs.io/)
[![PyPI](https://img.shields.io/pypi/v/mcdc.svg)](https://pypi.org/project/mcdc/)
[![DOI](https://joss.theoj.org/papers/10.21105/joss.06415/status.svg)](https://doi.org/10.21105/joss.06415)
[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)

MC/DC is an open-source, Python-based Monte Carlo radiation transport code that
combines rapid methods development with scalable, high-performance execution on
modern computing systems. Originally initiated by the Center for Exascale
Monte Carlo Neutron Transport ([CEMeNT](https://cement-psaap.github.io/)), MC/DC
development is now led by the Center for Advancing the Radiation Resilience of
Electronics ([CARRE](https://carre-psaapiv.org/)).

## Features

- Monte Carlo neutron transport (with photon and charged-particle capabilities
  under development)
- Time-dependent, steady-state, and eigenvalue simulations
- Multiple physics fidelities (continuous-energy/multi-group,
  single-scattering/condensed-history)
- Distributed-memory parallel execution with MPI
- Machine-portable Python implementation accelerated by Numba JIT compilation
- Extensible architecture for rapid methods development and prototyping

## Installation

Install the latest stable release from PyPI:

```bash
pip install mcdc
```

For development installation and additional options, see the
[Installation Guide](https://mcdc.readthedocs.io/en/latest/install.html).

## Documentation

Complete documentation is available on
[Read the Docs](https://mcdc.readthedocs.io/), including:

- [Installation](https://mcdc.readthedocs.io/en/latest/install.html)
- [User Guide](https://mcdc.readthedocs.io/en/latest/user/index.html)
- [API Reference](https://mcdc.readthedocs.io/en/latest/pythonapi/index.html)
- [Contribution Guide](https://mcdc.readthedocs.io/en/latest/contribution/index.html)

## Citing

If you use MC/DC in published work, please cite one or more of the following
references 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.*
  Proceedings of the ANS Mathematics & Computation Conference 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, request features, or ask questions, please open a
[GitHub Issue](https://github.com/mcdc-project/mcdc/issues).
