Merge pull request #197 from mwcraig/finally-finalize-dependencies

Finalize dependencies and update installation instructions

Author: mwcraig

README.md

@@ -10,7 +10,14 @@
 
 Either way, we will include some of the new features of ipywidgets 8 in the tutorial.
 
-### Installation instructions last updated 2022-06-17
+### Installation instructions last updated 2022-07-09
+
+#### Read this if you set up the tutorial environment before 2022-07-09
+
+> We have added two packages to the list of requirements on 2022-07-09. To add those packages to the environment you have already
+> created, either `conda install -c conda-forge mpl-interactions=0.22.0 orjson=3.7.7` or, if you use pip,
+> `pip install mpl-interactions==0.22.0 orjson==3.7.7`. Do not panic if you cannot update your environment; these packages are used in
+> only two or three cells.
 
 We **strongly recommend** using the conda Python distribution. You can install either [miniconda](https://conda.io/miniconda.html) (much smaller, only essential packages) or the full [anaconda distribution](https://www.continuum.io/downloads) (very extensive, but very, very large).
 

environment.yml

@@ -16,7 +16,9 @@ dependencies:
   - ipyvuetify=1.8.2
   - ipywidgets=7.7.0
   - jupyterlab=3.4
+  - mpl-interactions=0.22.0
   - numpy
+  - orjson=3.7.7  # Added 2022 for one of the ipygany examples
   - pandas
   - pip
   - python=3.9
@@ -28,5 +30,3 @@ dependencies:
   - sidecar=0.5.1
   - voila=0.3.5
   - vtk=9.1.0
-  - pip:
-    - mpl_interactions==0.22.0

install_check.py

@@ -22,6 +22,8 @@
     'jupyterlab',
     'voila',
     'pyvista',
+    'mpl_interactions',
+    'orjson',  # For one of the example in ipygany
 ]
 
 import_result = {p: False for p in requirements}

requirements.txt

@@ -12,7 +12,9 @@
  ipyvuetify==1.8.2
  ipywidgets==7.7.0
  jupyterlab==3.4
+ mpl-interactions==0.22.0
  numpy
+ orjson==3.7.7
  pandas
  pythreejs==2.3.0
  pyvista==0.34.0