Home

Running and updating the notebooks

To ensure reproducibility and make sure Binder works, it's important to install a standardized environment. Here's how:

1. Pull the trackpy-examples repo and create a new branch.

2. Remove the old examples environment if it exists: conda env remove -n trackpy-examples

3. Take a quick look at environment.yml and see if anything needs to be updated. Ideally there should be no pinned versions.

4. In the trackpy-examples repo:

   conda env create -f environment.yml
   conda activate trackpy-examples
   

5. To use this as a Jupyter kernel: python -m ipykernel install --user --name trackpy-examples --display-name trackpy-examples

6. If you are anticipating a new release of trackpy, you need to use the development version:

   conda remove trackpy
   pip install -e <your local trackpy repo>
   

7. If you would like to also run tests in this "clean" environment, run conda install nose and (optionally) pytest.