Dependencies

.github/workflows/ci.yaml

@@ -43,7 +43,7 @@ jobs:
           channels: conda-forge
           mamba-version: '*'
           channel-priority: strict
-          activate-environment: test_env_xmovie # Defined in ci/environment*.yml
+          activate-environment: xmovie-test # Defined in ci/environment*.yml
           auto-update-conda: false
           python-version: ${{ matrix.python-version }}
           environment-file: ci/environment.yml
@@ -86,9 +86,9 @@ jobs:
           key: ${{ runner.os }}-conda-${{ env.CACHE_NUMBER }}-${{ hashFiles('ci/environment-core-deps.yml') }}
       - uses: conda-incubator/setup-miniconda@v2
         with:
-          activate-environment: test_env_xmovie # Defined in ci/environment*.yml
+          activate-environment: xmovie-test-core # Defined in ci/environment*.yml
           auto-update-conda: false
-          python-version: 3.9
+          python-version: '3.9'
           environment-file: ci/environment-core-deps.yml
           use-only-tar-bz2: true # IMPORTANT: This needs to be set for caching to work properly!
       - name: Set up conda environment

.gitignore

@@ -25,6 +25,9 @@ var/
 .installed.cfg
 *.egg
 
+# Virtual environment
+venv*/
+
 # PyInstaller
 #  Usually these files are written by a python script from a template
 #  before PyInstaller builds the exe, so as to inject date/other infos into it.

.readthedocs.yaml

@@ -1,5 +1,9 @@
 version: 2
 
+python:
+  install:
+    - requirements: docs/requirements-rtd.txt
+
 build:
   os: "ubuntu-20.04"
   tools:

ci/environment-core-deps.yml

@@ -1,17 +1,20 @@
-name: test_env_xmovie
+# Conda environment for testing xmovie in CI
+name: xmovie-test-core
 channels:
   - conda-forge
+  - nodefaults
 dependencies:
-  - xarray
-  - dask
-  - scipy
-  - numpy
-  - pytest
-  - future
+  - python
+  #
+  # xmovie core
   - matplotlib
-  - cartopy
-  - pykdtree
+  - numpy
+  - xarray
+  #
+  - ffmpeg
+  #
+  # Tests
   - opencv
-  - pip:
-    - codecov
-    - pytest-cov
+  - pillow
+  - pytest
+  - pytest-cov

ci/environment.yml

@@ -1,19 +1,28 @@
-name: test_env_xmovie
+# Conda environment for testing xmovie in CI
+name: xmovie-test
 channels:
   - conda-forge
+  - nodefaults
 dependencies:
-  - xarray
-  - dask
-  - scipy
-  - numpy
-  - pytest
-  - future
+  - python
+  #
+  # xmovie core
   - matplotlib
-  - cartopy
-  - pykdtree
+  - numpy
+  - xarray
+  #
   - ffmpeg
-  - tqdm
+  #
+  # Extras
+  - cartopy
+  # - cftime
+  - dask-core
+  # - nc-time-axis
+  # - scipy
+  # - tqdm
+  #
+  # Test
   - opencv
-  - pip:
-    - codecov
-    - pytest-cov
+  - pillow
+  - pytest
+  - pytest-cov

ci/environment-docs.yml → docs/environment-docs-dev.yml

@@ -1,29 +1,35 @@
+# Conda environment for docs development,
+# including running the example notebooks
 name: xmovie-docs
 channels:
   - conda-forge
   - nodefaults
 dependencies:
   - python=3.8
-  # Core
-  - xarray
+  - pip
+  #
+  # xmovie core
   - matplotlib
-  - cartopy
-  - ffmpeg
+  - numpy
+  - xarray
+  #
   # Optional
-  - tqdm
+  - cartopy
   - dask-core
-  # Examples
-  - pooch
-  - jupyterlab
+  - tqdm
+  #
+  # Example notebooks
   - ipywidgets
+  - jupyterlab
+  - pooch
+  #
   # Docs
+  - nbsphinx
   - sphinx>=4.0
   - sphinx-autobuild
   - sphinx-book-theme
-  - nbsphinx
   - sphinx-copybutton
   #
-  - pip
   - pip:
     - sphinx-prompt
-    - '-e ../'  # xmovie
+    - '-e ../'  # xmovie itself

docs/examples/quickstart.ipynb

@@ -249,15 +249,15 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "![movie_fast.gif](movie_fast.gif)\n",
-    "![movie_slow.gif](movie_slow.gif)"
+    "![fast GIF](movie_fast.gif)\n",
+    "![slow GIF](movie_slow.gif)"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "![](movie_combo.gif)"
+    "![combo GIF](movie_combo.gif)"
    ]
   },
   {
@@ -297,7 +297,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "![](lon_movie.gif)"
+    "![lon dim GIF](lon_movie.gif)"
    ]
   },
   {
@@ -355,7 +355,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "![movie_rotating.gif](movie_rotating.gif)"
+    "![rotating GIF](movie_rotating.gif)"
    ]
   },
   {
@@ -395,7 +395,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "![](movie_rotating_dark.gif)"
+    "![rotating dark GIF](movie_rotating_dark.gif)"
    ]
   },
   {
@@ -440,8 +440,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "![](movie_cont.gif)\n",
-    "![](movie_contf.gif)"
+    "![rotating contour GIF](movie_cont.gif)\n",
+    "![rotating contourf GIF](movie_contf.gif)"
    ]
   },
   {
@@ -509,7 +509,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "![](movie_rasm.gif)"
+    "![RASM GIF](movie_rasm.gif)"
    ]
   },
   {
@@ -666,7 +666,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "![](movie_custom.gif)"
+    "![custom plotfunc movie](movie_custom.gif)"
    ]
   }
  ],

docs/index.rst

@@ -55,11 +55,18 @@ The main aims of this module are:
 Installation
 ------------
 
+.. important::
+
+   `ffmpeg`_ is required in order to create the movies from the saved PNG frames.
+   See `their installation instructions <https://ffmpeg.org/download.html>`_.
+   ``ffmpeg``\'s location must be in the OS search path (``PATH``) for movie creation to work.
+
 .. note::
 
    For now, ``dask(-core)`` and ``cartopy`` are included with ``xmovie``,
    but they may be optional dependencies in the future.
 
+
 Conda
 ~~~~~
 
@@ -69,6 +76,15 @@ The easiest way to install ``xmovie`` is via ``conda``:
 
    conda install -c conda-forge xmovie
 
+
+.. note::
+
+   conda-forge includes a recipe for ffmpeg. To install both:
+
+   .. prompt:: bash
+
+      conda install -c conda-forge xmovie ffmpeg
+
 Pip
 ~~~
 
@@ -103,3 +119,5 @@ If you want to install the latest version from GitHub, simply run
 .. _xarray: https://xarray.pydata.org
 .. _Matplotlib: https://matplotlib.org
 .. _Dask: https://dask.org
+.. _ffmpeg: https://ffmpeg.org/
+.. _ffmpeg-download: https://ffmpeg.org/download.html

docs/requirements-rtd.txt

@@ -0,0 +1,9 @@
+# pip requirements to build the docs on RTD
+# (example notebook deps are not needed since we do not run them in the docs build)
+../
+ipython
+nbsphinx
+sphinx ~= 4.0
+sphinx-book-theme
+sphinx-copybutton
+sphinx-prompt

docs/whats-new.rst

@@ -3,6 +3,14 @@ What's New
 v0.3.0 (unreleased)
 -------------------
 
+Packaging
+~~~~~~~~~
+- ``cartopy`` (used in the :func:`~xmovie.rotating_globe` preset)
+  and ``dask`` (used for parallel frame saving)
+  are now optional extras instead of package requirements
+  (:pull:`73`).
+  By `zmoon <https://github.com/zmoon>`_.
+
 Documentation
 ~~~~~~~~~~~~~
 - Sphinx docs build, published to Read the Docs (:pull:`67`).