Skip to content

Commit 99e4d47

Browse files
- Small doc change to add installation instructions and my name.
- Imported api postprocessing into a non-private namespace to indicate it is fully supported and renaming/moving it would be a breaking change.
1 parent 11763be commit 99e4d47

3 files changed

Lines changed: 9 additions & 2 deletions

File tree

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
setuptools.setup(
88
name="roguewavespectrum",
9-
version="0.2.20",
9+
version="0.2.21",
1010
license="Apache 2 License",
1111
install_requires=[
1212
"numpy",

src/roguewavespectrum/__init__.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,18 @@
3939
Ideally I would love to make this a community effort, and I would love to see others contribute to this package and
4040
become maintainers.
4141
42+
Pieter B. Smit, 2025
43+
4244
How well is this package tested?
4345
--------------------------------
4446
The package contains a number of unit tests, but those mostly test if the code runs, and if the code is consistent
4547
with previous behaviour, not if the code is correct. Most of these routines have been in use in
4648
my own work and calculations are based on well established theory.
4749
50+
Installation
51+
--------------------------------
52+
The easiest way to install the package is from pypi through pip: `pip install roguewavespectrum`.
53+
4854
Spectra
4955
=======
5056
We consider ocean surface-wave variance density spectra, either as:

src/roguewavespectrum/spotter/__init__.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,10 @@ class with the same cache file path. However, if you want to have more control o
104104
```
105105
"""
106106

107+
107108
from ._spotter_sdcard_data import read_spectral_csv as _read_spectral_csv
108109
from ._spotter_wavefleet_api import SofarFleet as _SofarFleet
110+
from ._spotter_post_processing import post_process_api_spectrum
109111

110112
SofarFleet = _SofarFleet
111-
112113
read_spectral_csv = _read_spectral_csv

0 commit comments

Comments
 (0)