flekspy

PyPI version

Python package for processing FLEKS (FLexible Exascale Kinetic Simulator) data.

Installation

python -m pip install flekspy

Usage

flekspy can load files generated from FLEKS.

import flekspy

ds = flekspy.load("sample_data/3*amrex")

Plotting is supported via Matplotlib and YT. For more detailed usage and contribution guide, please refer to the documentation.

ParaView Plugin

flekspy provides a ParaView plugin for visualizing FLEKS data. To use the plugin, follow these steps:

  1. Make sure the ParaView version is 5.13 or higher.

  2. Install flekspy for pvpython.

  • Go into the ParaView directory and create a virtual environment for Python

./bin/pvpython -m venv .venv

  • Check the Python version of pvpython

./bin/pvpython -c "import sys; print(sys.version)"

  • Install flekspy in the directory right in the venv. You may need to adjust the target path if pvpython does not detect flekspy. Assuming the Python version is 3.10.11, run

python3 -m pip  install --only-binary=:all: --python-version 3.10.11 --target ./.venv/lib/python3.10/site-packages/ flekspy

  1. Launch ParaView with the virtual environment

./bin/paraview --venv .venv

  1. In Tools > Manage Plugins, load the BATSRUSReader plugin.

License

flekspy is licensed under the terms of the MIT license.