Metadata-Version: 2.3
Name: mcnpy
Version: 0.2.4
Summary: 
License: GNU General Public License v3.0
Author: Juan Antonio Monleon de la Lluvia
Author-email: juanmonleon96@gmail.com
Requires-Python: >=3.12,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: matplotlib (>=3.10.0,<4.0.0)
Requires-Dist: pandas (>=2.2.3,<3.0.0)
Project-URL: Homepage, https://github.com/monleon96/MCNPy.git
Description-Content-Type: text/markdown

# MCNPy

[![Version](https://img.shields.io/badge/version-0.2.4-blue.svg)](https://github.com/monleon96/MCNPy)
[![Documentation Status](https://readthedocs.org/projects/mcnpy/badge/?version=latest)](https://mcnpy.readthedocs.io/en/latest/?badge=latest)

A Python package for working with MCNP input and output files. MCNPy provides a lightweight alternative to mcnptools, offering essential functionality for parsing, analyzing, and manipulating MCNP files in Python.

## Features

- Parse and manipulate MCNP input files (materials, PERT cards)
- Read and analyze MCTAL output files
- Compute sensitivity data
- Generate and visualize sensitivity profiles
- Create Sensitivity Data Files (SDF)

## Installation

```bash
pip install mcnpy
```

## Quick Start

```python
import mcnpy

# Read an MCNP input file
inputfile = "path/to/input_file"
input_data = mcnpy.read_mcnp(inputfile)

# Read a MCTAL file
mctalfile = "path/to/mctal_file"
mctal = mcnpy.read_mctal(mctalfile)

# Access materials
materials = input_data.materials

# Compute sensitivity data
from mcnpy.sensitivities import compute_sensitivity
sens_data = compute_sensitivity(inputfile, mctalfile, tally=4, nuclide=26056, label='Sensitivity Fe-56')
```

## Documentation

For complete documentation, examples, and API reference, visit:
[MCNPy Documentation](https://mcnpy.readthedocs.io/en/latest/)

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

