Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates to documentation with xarray tutorial data #151

Merged
merged 11 commits into from
Jul 1, 2021
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,356 changes: 1,319 additions & 37 deletions doc/DFT-iDFT_example.ipynb

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions doc/MITgcm_example.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"**Discrete Fourier Transform**\n",
"## Discrete Fourier Transform\n",
"\n",
"We chunk the data along the `time` and `Z` axes to allow parallelized computation and detrend and window the data before taking the DFT along the horizontal axes."
]
Expand Down Expand Up @@ -220,7 +220,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"**Power spectrum**\n",
"## Power spectrum\n",
"\n",
"We compute the surface eddy kinetic energy spectrum."
]
Expand Down Expand Up @@ -302,7 +302,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"**Isotropic wavenumber spectrum**\n",
"## Isotropic wavenumber spectrum\n",
"\n",
"We now isotropize the spectrum:"
]
Expand Down Expand Up @@ -427,7 +427,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"**Cross Spectrum**\n",
"## Cross Spectrum\n",
"\n",
"We calculate the cross correlation between vertical velocity ($w$) and buoyancy ($b$):"
]
Expand Down
2 changes: 1 addition & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "sphinx_rtd_theme"
# html_theme = "sphinx_rtd_theme"
# html_theme = 'alabaster'

# Theme options are theme-specific and customize the look and feel of a theme
Expand Down
1 change: 0 additions & 1 deletion doc/environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,4 @@ dependencies:
- pip:
- docrep
- nbsphinx
- sphinx_rtd_theme
- sphinxcontrib-apidoc
2 changes: 1 addition & 1 deletion xrft/tests/test_detrend.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ def noise(dims, shape):
@pytest.mark.parametrize("dim", ["t", "time"])
@pytest.mark.parametrize("detrend_type", ["constant", "linear"])
def test_dim_format(dim, detrend_type):
""" Check that detrend can deal with dim in various formats"""
"""Check that detrend can deal with dim in various formats"""
data = xr.DataArray(
np.random.random([10]),
dims=[dim],
Expand Down
2 changes: 1 addition & 1 deletion xrft/tests/test_xrft.py
Original file line number Diff line number Diff line change
Expand Up @@ -356,7 +356,7 @@ class TestSpectrum(object):
@pytest.mark.parametrize("window_correction", [True, False])
@pytest.mark.parametrize("detrend", ["constant", "linear"])
def test_dim_format(self, dim, window_correction, detrend):
""" Check that can deal with dim in various formats"""
"""Check that can deal with dim in various formats"""
data = xr.DataArray(
np.random.random([10]),
dims=[dim],
Expand Down