Skip to content

Commit

Permalink
Fixed even more typos in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ray-chew authored Mar 23, 2024
1 parent b515a04 commit 77cfe53
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

<p align="center">
<a href="https://github.com/ray-chew/pyBELLA/actions/workflows/documentation.yml">
<img alt="GitHub Actions: docs" src=https://github.com/ray-chew/pyBELLA/actions/workflows/documentation.yml/badge.svg>
<img alt="GitHub Actions: docs" src=https://img.shields.io/github/actions/workflow/status/ray-chew/pyBELLA/documentation.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>
Expand All @@ -23,9 +23,9 @@
</p>


The Blended sEamLess soLver for Atmospheric dynamics (pyBELLA) is a Python-based numerical flow solver for atmospheric dynamics. The current version features PyBELLA+ as it is coupled to an ensemble data assimillation engine based on the [Local Ensemble Transform Kalman Filter](https://www.sciencedirect.com/science/article/abs/pii/S0167278906004647).
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](https://www.sciencedirect.com/science/article/abs/pii/S0167278906004647).

The numerical scheme for pyBELLA was introduced by [Bennachio and Klein (2019)](https://journals.ametsoc.org/view/journals/mwre/147/11/mwr-d-19-0073.1.xml) and the seamless blending between model regimes within a simulation run was extended in [Chew et al. (2022)](https://journals.ametsoc.org/view/journals/mwre/150/9/MWR-D-21-0175.1.xml); see [`v0.3.0-localdab`](https://github.com/ray-chew/pyBELLA/releases/tag/archive%2Flocaldab) for the source code.
The numerical scheme for pyBELLA was introduced by [Bennachio and Klein (2019)](https://journals.ametsoc.org/view/journals/mwre/147/11/mwr-d-19-0073.1.xml), and the seamless blending between physical model regimes within a simulation run was extended in [Chew et al. (2022)](https://journals.ametsoc.org/view/journals/mwre/150/9/MWR-D-21-0175.1.xml); see [`v0.3.0-localdab`](https://github.com/ray-chew/pyBELLA/releases/tag/archive%2Flocaldab) for the source code.

This code was also used to produce the results in
* [Chew (2022)](https://refubium.fu-berlin.de/bitstream/handle/fub188/37313/thesis_final.pdf); [`v0.2.0-thesis`](https://github.com/ray-chew/pyBELLA/releases/tag/archive%2Fthesis)
Expand All @@ -34,7 +34,7 @@ This code was also used to produce the results in

---

**[Read the documentation here](https://ray-chew.github.io/pyBELLA/index.html)**
**[Read the (incomplete) documentation here](https://ray-chew.github.io/pyBELLA/index.html)**

---

Expand Down Expand Up @@ -64,14 +64,14 @@ pip install -e .

### Configuration

The user-defined input parameters are in the [`inputs`](https://github.com/ray-chew/pyBELLA/tree/develop/inputs) subpackage. These parameters are imported into the run scripts in [`run_scripts`](https://github.com/ray-chew/pyBELLA/tree/main/run_scripts).
The user-defined input parameters are in the [`inputs`](https://github.com/ray-chew/pyBELLA/tree/develop/inputs) subpackage. These parameters are imported into the run scripts in [`run_scripts`](https://github.com/ray-chew/pyBELLA/tree/develop/run_scripts).

### Execution

A simple test can be found in [`run_scripts.test_suite`](https://github.com/ray-chew/pyBELLA/blob/develop/run_scripts/test_dycore.py). To execute this run script from the pyBELLA parent directory:
A simple test can be found in [`run_scripts.test_dycore`](https://github.com/ray-chew/pyBELLA/blob/develop/run_scripts/test_dycore.py). To execute this test script from the pyBELLA parent directory:

```console
python3 ./run_scripts/test_dycore.py
pytest ./run_scripts/test_dycore.py -v
```

However, 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](https://ray-chew.github.io/pyBELLA/apis.html).
Expand Down

0 comments on commit 77cfe53

Please sign in to comment.