eX-Mech / pymech

A Python software suite for Nek5000 and SIMSON
https://pymech.readthedocs.io/en/stable
GNU General Public License v3.0
24 stars 24 forks source link
closember io nek5000 numpy simson xarray

Pymech

PyPI Build Status pre-commit.ci status Coverage Status Documentation Status DOI

A Python suite of routines for Nek5000 and SIMSON. Install with:

pip install pymech

Read the full documentation at Pymech doc.

Getting started

For some quick wins, download some sample data

curl -fLO https://raw.githubusercontent.com/eX-Mech/pymech-test-data/main/nek/channel3D_0.f00001

Fire up a Python / IPython console and execute:

import matplotlib.pyplot as plt
import pymech as pm

ds = pm.open_dataset('channel3D_0.f00001')
ds.mean(['x', 'z']).ux.plot()
plt.show()

You should see something like

For an overview of how to use pymech, follow the usage documentation.

Contributing

Found something that does not work? Want to add a new feature to pymech? Have a look at contributing guidelines.