stormbird_setup

A Python library that simplifies the setup of models that are to be used with the stormbird library.

The stormbird library is a Rust crate with a Python interface as well as several other interfaces. More info about this library can be found at the GitHub page

Philosophy

The point of this library is to implement the different input structures as Python classes that inherits from the Pydantic base model class. This allows for typed-checked creation of setup data, which is also easily converted to and from json strings, which is often the direct input to Stormbird.

The Python interface to Stormbird is called pystormbird. However, stormbird_setup does NOT require pystormbird to be installed AND it is supposed to be agnostic in terms of the flavor of Stormbird that is used. For instance, this library should be equally useful for setting up models for the FMU-version, the Python version, and the OpenFOAM version (actuator line simulations) of Stormbird.

In addition, since the point is to simplify the setup, it also contains simplified builders for typical simulations that may be performed with Stormbird.

Install instructions

A normal Python package. Can be installed by navigating into the folder and execute

pip install .

Or, it should also be available on PyPi, and therefore through

pip install stormbird_setup

Publishing to PyPI (maintainer cheat-sheet)

This section is a reminder for the main developer. Only the package owner has upload rights to PyPI.

This is a pure Python package, so both a source distribution and a wheel are uploaded.

1. Bump version in pyproject.toml and update CHANGELOG.md.
2. Remove old build artifacts and build:

   rm -rf dist build
   pip install build twine
   python -m build
   

3. Upload with an API token from PyPI (username __token__, password = the token):

   twine upload dist/*