DOC: create tabular-data.ipynb

.github/workflows/xskillscore_testing.yml

@@ -51,7 +51,7 @@ jobs:
         run: |
           pytest -n 4 --cov=xskillscore --cov-report=xml --verbose
       - name: Upload coverage to codecov
-        uses: codecov/codecov-action@v1.4.1
+        uses: codecov/codecov-action@v1.5.2
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           file: ./coverage.xml

CHANGELOG.rst

@@ -12,6 +12,7 @@ Internal Changes
 Documentation
 ~~~~~~~~~~~~~
 - Added more info in ``quick-start.ipynb`` (:pr:`316`) `Ray Bell`_.
+- Created ``tabular-data.ipynb`` (:pr:`330`) `Ray Bell`_.
 
 Breaking changes
 ~~~~~~~~~~~~~~~~

ci/docs_notebooks.yml

@@ -16,20 +16,21 @@ dependencies:
   # see https://github.com/xgcm/xhistogram/issues/48
   - xhistogram==0.1.2
   - importlib_metadata
+  - ipykernel
   - jupyterlab
   - matplotlib-base
   - nbsphinx
   - nbstripout
   - sphinx
-  - sphinxcontrib-napoleon
+  - sphinx-autosummary-accessors
   - sphinx_rtd_theme
+  - sphinxcontrib-napoleon
   - black
   - doc8
   - isort
   - flake8
   - pre-commit
   - pip
   - pip:
-      - sphinx_autosummary_accessors
       # Install latest version of xskillscore.
       - -e ..

docs/source/geophysical-data.ipynb

@@ -0,0 +1,39 @@
+{
+ "metadata": {
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": 3
+  },
+  "orig_nbformat": 4
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2,
+ "cells": [
+  {
+   "source": [
+    "# Geophysical Data\n",
+    "\n",
+    "See the [Quick Start](https://xskillscore.readthedocs.io/en/stable/quick-start.html) section.\n",
+    "\n",
+    "[climpred](https://climpred.readthedocs.io/en/stable/) has examples on evaluating climate predictions which uses `xskillscore`."
+   ],
+   "cell_type": "markdown",
+   "metadata": {}
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ]
+}

docs/source/index.rst

@@ -51,6 +51,8 @@ You can also install the bleeding edge (pre-release versions) by running:
     :caption: Getting Started
 
     quick-start.ipynb
+    geophysical-data.ipynb
+    tabular-data.ipynb
 
 **Help & Reference**