README.md

# SerPy: The Python API for Serpent
The API for Serpent2. Currently, SerPy includes basic features to support interactions with MCNPy.

# Dependencies
- `py4j`.
- `h5py`
- `psutil`
- `numpy`
- `metapy`
- Everything else should come with a standard Python install

# How to Install
1. Clone the repository: `git clone https://github.rpi.edu/NuCoMP/serpy.git`.
2. Ensure you are running the desired Python environment.
    - Try `conda activate ENV_NAME` to switch.
3. Run `pip install /path/to/cloned/repo/dist/serpy-X.whl` where `X` is the version.
    - All dependencies *except* `metapy` will be downloaded if needed.
    - `metapy` must be installed from the [metapy repository](https://github.rpi.edu/NuCoMP/metapy).
4. Done!

# Building a New Wheel
1. Use `pip uninstall serpy` to uninstall current version.
2. Run `python /path/to/cloned/repo/setup.py` to build the wheel.