PyBELLA

<p align="center"> <a href=""> <img alt="pyBELLA Logo" src="/docs/source/_static/logo.png"> </a> </p> <h2 align="center"><b><font color="#417b95">B</font></b>lended s<b><font color="#417b95">E</font></b>am<b><font color="#417b95">L</font></b>ess so<b><font color="#417b95">L</font></b>ver for <b><font color="#417b95">A</font></b>tmospheric dynamics</h2> <p align="center"> <a href="https://github.com/ray-chew/pyBELLA/actions/workflows/deploy.yml"> <img alt="GitHub Actions: docs" src=https://img.shields.io/github/actions/workflow/status/ray-chew/pyBELLA/deploy.yml?logo=github&label=docs> </a> <a href="https://github.com/ray-chew/pyBELLA/issues"> <img alt="open issues" src=https://img.shields.io/github/issues/ray-chew/pyBELLA> </a> <a href="https://opensource.org/licenses/BSD-3-Clause"> <img alt="License: BSD-3" src=https://img.shields.io/badge/License-BSD_3--Clause-blue.svg> </a> <!-- <a href="https://github.com/psf/black"> <img alt="Code style: black" src=https://img.shields.io/badge/code%20style-black-000000.svg> </a> --> </p>

The Blended sEamLess soLver for Atmospheric dynamics (pyBELLA) is a Python-based numerical flow solver. The current version features PyBELLA+ as it is coupled to an ensemble data assimillation engine based on the Local Ensemble Transform Kalman Filter.

The numerical scheme for pyBELLA was introduced by Benacchio and Klein (2019), and the seamless blending between physical model regimes within a simulation run was extended in Chew et al. (2022); see v0.3.0-localdab for the source code.

This code was also used to produce the results in

• Chew (2022); v0.2.0-thesis
• Chew et al. (2023); v0.4.0-coriolis

---

Read the documentation here

---

Requirements

See requirements.txt

Note: The development dependencies can be found in dev-requirements.txt.

To install the requirements:

pip install -r requirements.txt

Usage

Installation

Fork this repository and clone your remote fork. cd into your local forked repository and execute:

pip install -e . 

Note: depending on your IDE, you may need to add the --config-settings editable_mode at the end of the above command for the pyBELLA package to be visible to the linter. However, this comes with limitations to the development mode, see here for more details.

Configuration

The user-defined input parameters are in the inputs subpackage. These parameters are imported into the run scripts in run_scripts.

Execution

A simple test can be found in run_scripts.test_dycore. To execute this test script from the pyBELLA parent directory:

pytest ./run_scripts/test_dycore.py -v

To run a simulation:

pybella -ic rb -N 1

Note that only the rising bubble initial condition is implemented for now with ensemble size of 1.

The codebase is structured such that the user can easily assemble a run script to define their own experiments. Refer to the documentation for the available APIs.

License

BSD License v3.0

Contributions

Refer to the open issues, in particular issues with the help wanted label.

Any changes, improvements, or bug fixes can be submitted from your remote to upstream via a pull request.

To be tidied up

Profiler

$ PYTHONPATH=src scalene -m pybella -ic test_lamb_wave -N 1

Coverage

$ pytest --cov test_scripts/ --cov-report=html