Metadata-Version: 2.4
Name: m6sourceview
Version: 1.0.0
Summary: Python package for MORET6 fission source visualization in criticality mode
Author: Wilfried Monange
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.19.0
Requires-Dist: matplotlib>=3.0.0
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Dynamic: license-file

# M6SourceView

Python package helping to visualize fission sites in a MORET6 calculation.

## Installation

### From GitLab Release

Install directly from a GitLab release:

```bash
pip install https://gitlab.com/your-group/moret6sourceview/-/releases/v1.0.0/downloads/m6sourceview-1.0.0.tar.gz
```

Or download the release artifact and install locally:

```bash
pip install m6sourceview-1.0.0.tar.gz
```

### From Source

Clone the repository and install:

```bash
git clone https://gitlab.com/your-group/moret6sourceview.git
cd moret6sourceview
pip install .
```

### Development Installation

For development with editable mode:

```bash
pip install -e .
```

## Usage

Enable the `STAR` output in the MORET6 input file by adding the followin:

```
OUTP
	POST
		STAR
	ENDP
ENDO
```


### As a Python module

```bash
python3 -m m6sourceview input_file.m6
```

### As a command-line tool

```bash
m6sourceview input_file.m6
```

### Options

- `--nb_max_pixel INT`: Maximum number of pixels (default: 500)
- `--no-show`: Save plot without displaying

### Examples

```bash
python3 -m m6sourceview example/CPX_CONT_0001.m6
python3 -m m6sourceview example/CPX_CONT_0001.m6 --nb_max_pixel 1000
python3 -m m6sourceview example/CPX_CONT_0001.m6 --no-show
```

## Requirements

- Python 3.7+
- NumPy
- Matplotlib
- CMake (for building from source)
- C++ compiler with C++20 support
- pybind11 (for building from source)

