Metadata-Version: 2.1
Name: f4enix
Version: 0.6.0
Summary: API for Monte Carlo input and output parsing
Author: F4E neutronics team
Author-email: sc-radiationtransport@f4e.europa.eu
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: appdirs
Requires-Dist: asttokens
Requires-Dist: attrs
Requires-Dist: backcall
Requires-Dist: charset-normalizer
Requires-Dist: colorama
Requires-Dist: comm
Requires-Dist: contourpy
Requires-Dist: cycler
Requires-Dist: debugpy
Requires-Dist: decorator
Requires-Dist: et-xmlfile
Requires-Dist: exceptiongroup
Requires-Dist: executing
Requires-Dist: fonttools
Requires-Dist: idna
Requires-Dist: imageio
Requires-Dist: iniconfig
Requires-Dist: jedi
Requires-Dist: kiwisolver
Requires-Dist: matplotlib
Requires-Dist: matplotlib-inline
Requires-Dist: nest-asyncio
Requires-Dist: numba
Requires-Dist: numjuggler
Requires-Dist: numpy
Requires-Dist: openpyxl
Requires-Dist: packaging
Requires-Dist: pandas
Requires-Dist: parso
Requires-Dist: pathlib2
Requires-Dist: pickleshare
Requires-Dist: Pillow
Requires-Dist: platformdirs
Requires-Dist: pluggy
Requires-Dist: pooch
Requires-Dist: prompt-toolkit
Requires-Dist: psutil
Requires-Dist: pure-eval
Requires-Dist: pycodestyle
Requires-Dist: Pygments
Requires-Dist: pyparsing
Requires-Dist: pytest
Requires-Dist: python-dateutil
Requires-Dist: python-docx
Requires-Dist: pytz
Requires-Dist: pyvista >=0.39.1
Requires-Dist: pyzmq
Requires-Dist: requests
Requires-Dist: scipy
Requires-Dist: scooby
Requires-Dist: six
Requires-Dist: stack-data
Requires-Dist: tables
Requires-Dist: tomli
Requires-Dist: tornado
Requires-Dist: tqdm
Requires-Dist: traitlets
Requires-Dist: urllib3
Requires-Dist: vtk
Requires-Dist: wcwidth
Requires-Dist: wincertstore

[![Testing windows](https://github.com/Radiation-Transport/F4Enix/actions/workflows/AutomatedTests_win.yml/badge.svg?branch=main)](https://github.com/Radiation-Transport/F4Enix/actions/workflows/AutomatedTests_win.yml)
[![Testing linux](https://github.com/Radiation-Transport/F4Enix/actions/workflows/AutomatedTests_linux.yml/badge.svg?branch=main)](https://github.com/Radiation-Transport/F4Enix/actions/workflows/AutomatedTests_linux.yml)
[![PyPi version](https://badgen.net/pypi/v/f4enix/)](https://pypi.org/project/f4enix)
[![Documentation Status](https://readthedocs.org/projects/f4enix/badge/?version=latest)](https://f4enix.readthedocs.io/en/latest/?badge=latest)

# F4Enix
Parser for Monte Carlo simulations input and output files

**Pyhton >3.9!**

Both Windows and Linux supported.

Go to [F4Enix official documentation](https://f4enix.readthedocs.io/en/latest/) to get
more information on the library capabilities, examples and much more.

## Install
The easiest way to install F4Enix is using pip:

```
pip install f4enix
```

### Troubleshooting and developer mode
If any unexpected issue is encountered during installation, the first step for
its resolution would be to create a new fresh virtual environment.
In conda this would be done with:
```
conda create -n <env_name> python=3.10
```
Please remember that python versions lower than 3.10 are not supported.

### Developer mode installation
There are many situations (especially while being an active developer) where it may be useful to install f4enix in developer mode. In order to do so, navigate to the
F4Eparser folder and type the following to be sure that your pip is
up to date (optional):
```
python -m pip install --upgrade pip setuptools wheel
```
and then to install the package:
```
python3 -m pip install -e .
```

This installation will only save the package info in your local environment
while it will point to your local folder to get the actual package code.
This means that when you have the package installed (i.e. that you can
use in whatever directory) you will still be able to modify the package
source code without the need for re-installing the package.

This also means though that if you move the F4Eparser folder, the link will
be broken and you will need to reinstall the package. Anyhow, if you are
working on your local GitHub repo to modify the code (as it should be) this
should never be moved anyway.
