Skip to content

Commit

Permalink
Add standard packages to shorten docstring example
Browse files Browse the repository at this point in the history
  • Loading branch information
ecomodeller committed Dec 5, 2022
1 parent 8ae0d2f commit 02c4e4c
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 5 deletions.
19 changes: 19 additions & 0 deletions conftest.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# content of conftest.py
import pytest
import numpy
import pandas
import mikeio


@pytest.fixture(autouse=True)
def add_np(doctest_namespace):
doctest_namespace["np"] = numpy

@pytest.fixture(autouse=True)
def add_pd(doctest_namespace):
doctest_namespace["pd"] = pandas


@pytest.fixture(autouse=True)
def add_mikeio(doctest_namespace):
doctest_namespace["mikeio"] = mikeio
3 changes: 0 additions & 3 deletions mikeio/dfsu.py
Original file line number Diff line number Diff line change
Expand Up @@ -870,8 +870,6 @@ def write_header(
Examples
--------
>>> from datetime import datetime
>>> import numpy as np
>>> import mikeio
>>> meshfilename = "tests/testdata/north_sea_2.mesh"
>>> outfilename = "bigfile.dfsu"
>>> dfs = mikeio.Dfsu(meshfilename)
Expand Down Expand Up @@ -1226,7 +1224,6 @@ def extract_track(self, track, items=None, method="nearest", dtype=np.float32):
Examples
--------
>>> import mikeio
>>> dfsu = mikeio.open("tests/testdata/NorthSea_HD_and_windspeed.dfsu")
>>> ds = dfsu.extract_track("tests/testdata/altimetry_NorthSea_20171027.csv")
>>> ds
Expand Down
2 changes: 0 additions & 2 deletions mikeio/dfsu_spectral.py
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,6 @@ def read(
Examples
--------
>>> import mikeio
>>> mikeio.read("tests/testdata/line_spectra.dfsu")
<mikeio.Dataset>
dims: (time:4, node:10, direction:16, frequency:25)
Expand Down Expand Up @@ -293,7 +292,6 @@ def plot_spectrum(
Examples
--------
>>> import mikeio
>>> dfs = mikeio.Dfsu("tests/testdata/area_spectra.dfsu")
>>> ds = dfs.read(items="Energy density")
>>> spectrum = ds[0][0, 0, :, :] # first timestep, element 0
Expand Down

0 comments on commit 02c4e4c

Please sign in to comment.