diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index bd5b0c5..9912662 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -34,3 +34,9 @@ jobs: run: | micromamba activate TEST python -m pytest -rxs tests + + - name: Doctests + shell: bash -l {0} + run: | + micromamba activate TEST + python -m pytest -s -rxs --doctest-modules -vv ctd diff --git a/ctd/__init__.py b/ctd/__init__.py index 489b9df..88076fc 100644 --- a/ctd/__init__.py +++ b/ctd/__init__.py @@ -15,7 +15,15 @@ smooth, split, ) -from .read import from_bl, from_btl, from_cnv, from_edf, from_fsi, rosette_summary +from .read import ( + from_bl, + from_btl, + from_castaway_csv, + from_cnv, + from_edf, + from_fsi, + rosette_summary, +) try: from ._version import __version__ @@ -28,6 +36,7 @@ "despike", "from_bl", "from_btl", + "from_castaway_csv", "from_cnv", "from_edf", "from_fsi", diff --git a/ctd/read.py b/ctd/read.py index 773cebb..c0544f5 100644 --- a/ctd/read.py +++ b/ctd/read.py @@ -522,10 +522,10 @@ def from_castaway_csv(fname): -------- >>> import ctd >>> cast = ctd.from_castaway_csv('tests/data/castaway_data.csv') - >>> downcast, upcast = cast.split() # Upcast often prefiltered - >>> fig, ax = plt.subplots() - >>> ax = downcast['temperature'].plot_cast() - >>> fig.show() + >>> cast.columns + Index(['depth', 'temperature', 'conductivity', 'specific_conductance', + 'salinity', 'sound_velocity', 'density'], + dtype='object') """ with open(fname) as file: diff --git a/tests/data/castaway_data.csv b/tests/data/castaway_data.csv old mode 100755 new mode 100644