eddy-mc 0.3.6
Eddy, the MCNP and SCALE HTML output converter
Requires Python: >=3.6

![logo](https://cerberusnuclear.com/wp-content/uploads/2020/10/EddyLinkedin.jpg)


[![PyPI version](https://badge.fury.io/py/eddy-mc.svg)](https://badge.fury.io/py/eddy-mc)

Eddy is a HTML output generator for MCNP and SCALE, it imports an MCNP or SCALE output file, extracts the important 
data, and writes it to a user-friendly HTML file.

This repository contains the source code version of Eddy, however Eddy is also available as 
[a pre-compiled executable](https://github.com/Cerberus-Nuclear/Eddy).

### Source Code CLI Usage
Eddy can be run from the command line with the output file and any applicable scaling factor as optional arguments; if 
no such arguments are supplied a GUI will appear to request them.

General CLI usage:

```bash
python3 eddy.py [-o outputfile] [-sf scaling_factor]
```

### PyPI Package Usage
Eddy is also available on the PyPI Python Package index as eddy-mc, in order to allow easier integration into other 
programs. It can be installed using pip:

```bash
pip install eddy-mc
```

and accessed using:

```python
from eddymc import eddy
eddy.main()
```
where `eddy.main()` can take the same two optional arguments; the filepath for the MCNP output and a scaling factor. 
If these are not supplied, the GUI will appear to request them when `eddy.main()` is called.

Additionally, for Linux installs the wrapper script in `bin/eddy` will be placed in the `/usr/local/bin`
directory, placing it into the user's `PATH` and allowing eddy to be called directly from any command line with 
the following command:
```
eddy outputfile [-h] [-sf SCALING_FACTOR] 
```
This method is intended for pure command-line use, so when eddy is called in this way, the filename argument is 
non-optional, and if no scaling factor is supplied a default
of 1.0 will be assumed; this CLI interface will prevent the GUI window from appearing to request these values.

## Features
Features include:
- Eddy can convert F2, F4, F5, F6 and F6+ tallies
- Eddy can accept average tallies, given in the form `F4:N (4 5)`
- Eddy can take an MCNP criticality output and show k-effective for the 
first half, second half and total calculation.
- Eddy will present a warning if an MCNP case was halted due to lost particles
- Eddy will clearly present any FATAL ERROR messages in the MCNP output
- Eddy currently **does not** accept multi-particle tallies of the form `F4:N,P`
- For F2, F4 and F5 tallies, the units are presented as microSieverts per hour.
  The actual result from MCNP is typically multiplied by some conversion factor, so the
  tally output could be in any unit. The uSv/h units have been left in for now as this
  seems to be by far the most common conversion factor used for shielding calculations. 
- Any valid HTML tags found in the MCNP output file will be escaped, preventing any unwanted
HTML or javascript injected into the MCNP output from making its way into the HTML output file.

Requirements

- Python 3.6 or later
- Jinja2 Python package is required (will be included automatically if Eddy is installed via pip)
- importlib_resources may be required for versions of python < 3.9
- pytest and pytest-mock Python packages are required to run the unit tests

<details>
  <summary>Example HTML outputs</summary>
  <img src="https://cerberusnuclear.com/wp-content/uploads/2020/10/eddy-screen-shot-2.jpg" name="image-name">
  <img src="https://cerberusnuclear.com/wp-content/uploads/2020/10/Results_Summary-1.jpg" name="image-name">
  <img src="https://cerberusnuclear.com/wp-content/uploads/2020/10/Results_Stats-1.jpg" name="image-name">
  <img src="https://cerberusnuclear.com/wp-content/uploads/2020/10/WarningsComments.jpg" name="image-name">
  <img src="https://cerberusnuclear.com/wp-content/uploads/2020/10/particles-1.jpg" name="image-name">
</details>