https://github.com/ex-mech/pymech

A Python software suite for Nek5000 and SIMSON
https://github.com/ex-mech/pymech

closember io nek5000 numpy simson xarray

Last synced: 4 days ago
JSON representation

A Python software suite for Nek5000 and SIMSON

• Host: GitHub
• URL: https://github.com/ex-mech/pymech
• Owner: eX-Mech
• License: gpl-3.0
• Created: 2016-01-27T14:02:53.000Z (almost 9 years ago)
• Default Branch: main
• Last Pushed: 2025-01-07T23:26:19.000Z (18 days ago)
• Last Synced: 2025-01-20T14:46:38.687Z (6 days ago)
• Topics: closember, io, nek5000, numpy, simson, xarray
• Language: Python
• Homepage: https://pymech.readthedocs.io/en/stable
• Size: 12.6 MB
• Stars: 26
• Watchers: 6
• Forks: 24
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Citation: CITATION.cff

Awesome Lists containing this project

README

        
# Pymech

[![PyPI](https://img.shields.io/pypi/v/pymech)](https://pypi.org/project/pymech/)

[![Build Status](https://img.shields.io/github/actions/workflow/status/eX-Mech/pymech/build.yaml?branch=main)](https://github.com/eX-Mech/pymech/actions)

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/eX-Mech/pymech/main.svg)](https://results.pre-commit.ci/latest/github/eX-Mech/pymech/main)

[![Coverage Status](https://coveralls.io/repos/github/eX-Mech/pymech/badge.svg)](https://coveralls.io/github/eX-Mech/pymech)

[![Documentation Status](https://readthedocs.org/projects/pymech/badge/?version=latest)](http://pymech.readthedocs.org/en/stable/)

[![DOI](https://zenodo.org/badge/50511298.svg)](https://zenodo.org/badge/latestdoi/50511298)

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

```

pip install pymech

```

Read the full documentation at [Pymech doc](http://pymech.readthedocs.io/en/stable).

## Getting started

For some quick wins, download some sample data

```sh

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

```

Fire up a Python / IPython console and execute:

```py

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

![](https://pymech.readthedocs.io/en/stable/_images/usage_37_1.png)

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

documentation](https://pymech.readthedocs.io/en/stable/usage.html).

## Contributing

Found something that does not work? Want to add a new feature to pymech? Have a

look at [contributing

guidelines](https://pymech.readthedocs.io/en/stable/contributing.html).

[Nek5000]: https://nek5000.mcs.anl.gov/

[SIMSON]: https://github.com/KTH-Nek5000/SIMSON/