Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 998 Bytes

File metadata and controls

41 lines (29 loc) · 998 Bytes

MiniStag

2D convection solver.

This is inspired from the 2D convection code by Paul Tackley available at http://jupiter.ethz.ch/~pjt/Convection2D.m

Installation

ministag is coded in Python and can be installed using uv to manage Python environments.

You can then install ministag with the following commands from the root of the repository (i.e. where the pyproject.toml file is):

uv tool install .

This installs ministag in a dedicated virtual environment and makes it available in a standard location (usually ~/.local/bin).

Running

ministag is configurable through a parameter file named par.toml. If that file doesn't exist, run ministag once to create it with default values:

ministag

You can then modify par.toml as desired and rerun ministag to perform your simulation. You can run the following to display a short explanation of the available options:

ministag help