Skip to content

Commit 0b922e1

Browse files
authored
doc: revise README for maintenance mode notice
Update README to indicate maintenance mode and suggest alternatives.
1 parent dbf7027 commit 0b922e1

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,20 @@
22

33
[![CI](https://github.com/org-arl/arlpy/workflows/CI/badge.svg)](https://github.com/org-arl/arlpy/actions)
44

5+
> [!NOTE]
6+
> **This package is now in maintainence mode** and not being actively developed. I personally no longer use
7+
> Python much, as all my scientific work has now moved to Julia. I still maintain this package for others
8+
> who use it, but new features rarely get implemented. I am, however, happy to review and take in PRs from
9+
> contributors who would like to add features or fix bugs.
10+
11+
> [!TIP]
12+
> For those of you who use this package as a Python front-end to BELLHOP, there is now a better option to consider.
13+
> The [`UnderwaterAcoustics.jl`](https://github.com/org-arl/UnderwaterAcoustics.jl) ecosystem provides
14+
> a unified interface to a variety of propagation models including BELLHOP, KRAKEN, etc. Although developed
15+
> for Julia, the packages can [easily be used from Python](https://org-arl.github.io/UnderwaterAcoustics.jl/python.html).
16+
17+
## Introduction
18+
519
Packages such as `numpy` and `scipy` provide excellent mathematical tools for
620
scientists and engineers using Python. However, these packages are still young
721
and evolving, and understandably have some gaps, especially when it comes to

0 commit comments

Comments
 (0)