pvisor 0.1.2

No project description provided

PVISOR - Reading plot files from thermohydraulic codes

The PVISOR library, developed at NRG PALLAS, allows you to read in plot files from thermohydraulic codes for further data analysis using python. Data is represented in a pandas DataFrame. PVISOR is compatible with plot files from the following codes:

• RELAP5
• SPECTRA
• TRACE
• MELCOR

Usage

PVISOR can be called installed using pip:

pip install pvisor

Import the library and use the read_file() function, which allows all suported datafiles to be read.

# Import the library
import pvisor

# Read a file, code should be "RELAP", "SPECTRA", "TRACE" or "MELCOR"
data = pvisor.read_file("plotfile.plt", code="RELAP")

# Print a variable in your file
print(data["rktpow"])
print(data["rho-1010000"])

Building from source

To install from source, first install requirements. For Ubuntu these are

# For ubuntu
sudo apt install rust python

Then clone this repository

git clone [e-mail]:stijnfranssen/pvisor.git
cd pvisor

Create a virtual environment and install the prerequisites:

python3 -m venv venv
source venv/bin/activate
python3 -m pip install maturin

Build the rust elements

maturin develop --release

Test if output works

pytest

Optional: Build documentation

The documentation is created using Sphinx and are build using:

cd docs
make html