snek5000

Spec sheet

What it does

Snek5000 is a Python framework and thin interface for Nek5000 that organizes parameters, launches and restarts simulations, and loads simulation data for figures and movies.Read 11 Oct 2026 · snek5000.readthedocs.io

Purpose

Snek5000 is a Python framework and thin interface for organizing, launching, and restarting Nek5000 simulations, then loading their data for analysis and visualization.Read 11 Oct 2026 · snek5000.readthedocs.io

Free plan

YesRead 24 Sep 2026 · snek5000.readthedocs.io

Integrations

The documentation lists Snakemake, Fluidsim, Pymech, Matplotlib, Jinja, Pytest, and Xarray among the Python packages Snek5000 uses.Read 11 Oct 2026 · snek5000.readthedocs.io

License

The GitHub repository identifies the project license as BSD-3-Clause.Read 11 Oct 2026 · github.com

Assessment tools

NoRead 24 Sep 2026 · snek5000.readthedocs.io

Authoring tools

YesRead 24 Sep 2026 · snek5000.readthedocs.io

Compatibility limit

The documentation recommends the project's Nek5000 fork based on v19 and says the upstream master branch is not supported because of a bug and working-directory changes.Read 11 Oct 2026 · snek5000.readthedocs.io

Delivery mode

desktopRead 24 Sep 2026 · snek5000.readthedocs.io

Example solvers

The documentation points to the open-source snek5000-phill, snek5000-cbox, and snek5000-tgv solvers.Read 11 Oct 2026 · snek5000.readthedocs.io

Installation

The documented installation method is pip install snek5000, with conda or mamba described for setting up environments in certain cases.Read 11 Oct 2026 · snek5000.readthedocs.io

Lesson library

NoRead 24 Sep 2026 · snek5000.readthedocs.io

Limitations

The project says users need basic Python knowledge, and deeper solver modifications require learning Snakemake functions and Jinja templates.Read 11 Oct 2026 · snek5000.readthedocs.io

Nek5000 compatibility

The installation guide recommends the project’s Nek5000 fork based on v19 and says the bleeding-edge master branch is not supported because of a bug.Read 11 Oct 2026 · snek5000.readthedocs.io

Offline access

YesRead 24 Sep 2026 · snek5000.readthedocs.io

Parameter handling

It provides named defaults, parameter consistency checks, and records simulation metadata in XML and YAML files.Read 11 Oct 2026 · snek5000.readthedocs.io

Parameters

It provides sensible parameter names and defaults, consistency checks, and records simulation metadata in XML and YAML files.Read 11 Oct 2026 · snek5000.readthedocs.io

Post-processing

Its output tools can plot physical fields and animate them, and can load and plot history points.Read 11 Oct 2026 · snek5000.readthedocs.io

Prerequisites

Snek5000 requires Python 3.8 or later and the NEK_SOURCE_ROOT environment variable pointing to a Nek5000 source directory.Read 11 Oct 2026 · snek5000.readthedocs.io

Requirements

Snek5000 requires Python 3.8 or newer and a Nek5000 source tree configured through NEK_SOURCE_ROOT.Read 11 Oct 2026 · snek5000.readthedocs.io

Simulation control

Users can launch and restart simulations with Python scripts or terminal commands.Read 11 Oct 2026 · snek5000.readthedocs.io

Solver development

It lets users build Fluidsim solvers based on Nek5000 cases, and the documentation links open-source periodic-hill, sidewall-convection, and Taylor–Green-vortex solvers.Read 11 Oct 2026 · snek5000.readthedocs.io

Support and contributions

The project welcomes testing, issue reports, and patches, and links to contribution guidelines.Read 11 Oct 2026 · snek5000.readthedocs.io

User profile

The documentation says basic Python knowledge is needed and deeper solver modifications require learning Snakemake and Jinja templates.Read 11 Oct 2026 · snek5000.readthedocs.io

Visualization

Its examples show plotting physical fields and animating pressure data, and its history-point output can be plotted or loaded for further processing.Read 11 Oct 2026 · snek5000.readthedocs.io

Workflow

It supports out-of-source builds, scriptable runs for parametric studies, and offline post-processing or restarting of simulations.Read 11 Oct 2026 · snek5000.readthedocs.io

Workflow features

The framework supports per-run out-of-source builds, scriptable parametric studies, and offline post-processing and restart.Read 11 Oct 2026 · snek5000.readthedocs.io

Where Specifiction places it

• Physics Simulation Software#76 of 897.0