From bb875ec99ea2fde26b559e15c7c9c55cbcffd540 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Mon, 22 Jul 2019 12:38:57 -0700 Subject: [PATCH 01/19] Add local requirements and unpin packages --- requirements-local.txt | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 requirements-local.txt diff --git a/requirements-local.txt b/requirements-local.txt new file mode 100644 index 00000000..f5521789 --- /dev/null +++ b/requirements-local.txt @@ -0,0 +1,8 @@ +cite2c +econ-ark +ipywidgets +jupyter +jupyter_contrib_nbextensions +matplotlib +numpy +scipy From 837d2a40bac2caa5408d2a0db1c207ea16554a4d Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Mon, 22 Jul 2019 12:47:18 -0700 Subject: [PATCH 02/19] Update readme --- README.md | 58 ++++++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 51 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index eadd9010..03b51ab5 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,56 @@ This repository contains demos and documentation for [HARK](https://github.com/e [![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/econ-ark/DemARK/master) +## Try the notebooks on Binder + +**No installation is needed. Runs in a web browser** + +Click the Binder link. Binder builds an environment in the cloud for you to use. +The first time Binder launches it may take a while since it is busy creating a +container to run the demo notebooks. Subsequent launches should be quicker. + +TODO add binder link and specify a SHA1 + ## Local installation +The installation instructions are provided for Python 3.6+. + +### Option 1a: With Jupyter using pip + +1. Create a virtual environment (using the CPython `venv` command). +2. Activate the `myarkenv` environment. +3. Upgrade pip. +4. Use pip to install requirements. +5. Run Jupyter notebook. + +``` +python3 -m venv myarkenv +source myarkenv/bin/activate +pip install --upgrade pip +pip install -r requirements-local.txt +jupyter notebook +``` + +This will launch the jupyter file browser. The notebooks can be selected and +run. + + +### Option 1b: With Jupyter using conda + +TODO: create an environment.yml + +### Option 2 + +TODO Create a docker container and host on Docker Hub. + +--- + ### Option 1: With Jupyter -0. [Install jupyter](https://jupyter.org/install). -1. Clone `DemARK` to the folder of your choice -2. Run `pip install -r binder/requirements.txt` to install dependencies -3. Enable notebook extensions. +1. [Install jupyter](https://jupyter.org/install). +2. Clone `DemARK` to the folder of your choice +3. Run `pip install -r binder/requirements.txt` to install dependencies +4. Enable notebook extensions. **On Linux/macOS:** @@ -21,8 +63,8 @@ This repository contains demos and documentation for [HARK](https://github.com/e Run `binder/postBuild.bat` -4. Run `jupyter notebook` from the `DemARK` root folder. You will be prompted to open a page in your web browser. From there, you will be able to run the notebooks. -5. Run the notebook by clicking the `▶▶` button or choosing `Kernel → Restart & Run All` +5. Run `jupyter notebook` from the `DemARK` root folder. You will be prompted to open a page in your web browser. From there, you will be able to run the notebooks. +6. Run the notebook by clicking the `▶▶` button or choosing `Kernel → Restart & Run All` ### Option 2: With Docker and repo2docker @@ -32,13 +74,15 @@ This repository contains demos and documentation for [HARK](https://github.com/e 3. Follow the link in your terminal to the running instance of jupyter 4. Run the notebook by clicking the `▶▶` button or choosing `Kernel → Restart & Run All` +--- + ## Contributions We are eager to encourage contributions. These can take the form either of new notebooks, or proposed edits for existing notebooks. Either kind of contribution can be made by issuing a pull request. -However, to deal with the well-known problem that normal jupyter notebooks do not "play nicely" with github version control, we will require interactions +However, to deal with the well-known problem that normal jupyter notebooks do not "play nicely" with github version control, we will require interactions with contributors to be conducted after the installation of the [jupytext](https://towardsdatascience.com/introducing-jupytext-9234fdff6c57) tool. Specifically, you will need to follow the instructions for installing jupytext on your computer, and then need to configure it to use the "percent" format. Over time, we intend to add the necessary metadata to all our jupyter notebooks to make them automatically invoke jupytext when compiled. From 6999deb6e03cc6e4dc0ac4cb1fc5ef50437c0817 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Mon, 22 Jul 2019 12:50:13 -0700 Subject: [PATCH 03/19] rename binder folder for testing --- {binder => holding-dir-binder}/postBuild | 0 {binder => holding-dir-binder}/postBuild.bat | 0 {binder => holding-dir-binder}/requirements.txt | 2 -- {binder => holding-dir-binder}/runtime.txt | 0 4 files changed, 2 deletions(-) rename {binder => holding-dir-binder}/postBuild (100%) rename {binder => holding-dir-binder}/postBuild.bat (100%) rename {binder => holding-dir-binder}/requirements.txt (98%) rename {binder => holding-dir-binder}/runtime.txt (100%) diff --git a/binder/postBuild b/holding-dir-binder/postBuild similarity index 100% rename from binder/postBuild rename to holding-dir-binder/postBuild diff --git a/binder/postBuild.bat b/holding-dir-binder/postBuild.bat similarity index 100% rename from binder/postBuild.bat rename to holding-dir-binder/postBuild.bat diff --git a/binder/requirements.txt b/holding-dir-binder/requirements.txt similarity index 98% rename from binder/requirements.txt rename to holding-dir-binder/requirements.txt index 016cb53f..31a8f3c7 100644 --- a/binder/requirements.txt +++ b/holding-dir-binder/requirements.txt @@ -5,5 +5,3 @@ scipy==1.0.0 jupyter_contrib_nbextensions cite2c econ-ark==0.10.1.dev3 - - diff --git a/binder/runtime.txt b/holding-dir-binder/runtime.txt similarity index 100% rename from binder/runtime.txt rename to holding-dir-binder/runtime.txt From 991f95f8eadd0ee7eccdcb665065b60cca4800cb Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Mon, 22 Jul 2019 12:54:15 -0700 Subject: [PATCH 04/19] rename requirements so binder will find at root --- requirements-local.txt => requirements.txt | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename requirements-local.txt => requirements.txt (100%) diff --git a/requirements-local.txt b/requirements.txt similarity index 100% rename from requirements-local.txt rename to requirements.txt From 62340649450d3711bca172f703b2115d20cea5f9 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Mon, 22 Jul 2019 13:13:29 -0700 Subject: [PATCH 05/19] add binder link to carol branch --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 03b51ab5..3533d002 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,10 @@ Click the Binder link. Binder builds an environment in the cloud for you to use. The first time Binder launches it may take a while since it is busy creating a container to run the demo notebooks. Subsequent launches should be quicker. -TODO add binder link and specify a SHA1 +**Use this link while testing** + +[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/willingc/DemARK/troubleshoot) + ## Local installation From a526ed4cbc6db587ce21e6d5d7a80ae8898a3574 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Tue, 23 Jul 2019 10:17:34 -0700 Subject: [PATCH 06/19] add extension install/enable --- README.md | 33 +++++++++++++++++++++++++++++++-- 1 file changed, 31 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3533d002..857ac580 100644 --- a/README.md +++ b/README.md @@ -27,19 +27,48 @@ The installation instructions are provided for Python 3.6+. 2. Activate the `myarkenv` environment. 3. Upgrade pip. 4. Use pip to install requirements. -5. Run Jupyter notebook. +5. Add and enable notebook extensions +6. Run Jupyter notebook. ``` python3 -m venv myarkenv source myarkenv/bin/activate pip install --upgrade pip pip install -r requirements-local.txt -jupyter notebook ``` This will launch the jupyter file browser. The notebooks can be selected and run. +You may also wish to activate a few notebook extensions for convenience: + +``` +# Docs on nbextensions: https://jupyter-contrib-nbextensions.readthedocs.io +jupyter contrib nbextension install --user # installs css/js and nbconvert config info +jupyter nbextension enable codefolding/main # enable codefolding in a notebook code cell +jupyter nbextension enable codefolding/edit # enable codefolding in editor +jupyter nbextension enable --py latex_envs # enable some latex features into notebook +python3 -m cite2c.install # Enables the cite2c extension (you will need to log into zotero if you use this extension) **Optional** +jupyter notebook +``` + +Locally, you can enable/disable extensions by: http://localhost:8888/nbextensions + + +--- + +TODO Note for Binder (Hash or hide access token) + +``` +result=$(python < Date: Tue, 23 Jul 2019 10:39:28 -0700 Subject: [PATCH 07/19] add temporary todo file --- todo.txt | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 todo.txt diff --git a/todo.txt b/todo.txt new file mode 100644 index 00000000..112618b5 --- /dev/null +++ b/todo.txt @@ -0,0 +1,3 @@ +Check widgets are working fine in: notebooks/TractableBufferStockQuickDemo.ipynb +Double check codefolding +Check latex_env From 0f04d0f1cf88a8f48ef85b8591e41a2b9d0b19fc Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Tue, 23 Jul 2019 10:46:20 -0700 Subject: [PATCH 08/19] add requirements and post build instructions --- binder/postBuild | 19 +++++++++++++++++++ binder/requirements.txt | 8 ++++++++ 2 files changed, 27 insertions(+) create mode 100755 binder/postBuild create mode 100644 binder/requirements.txt diff --git a/binder/postBuild b/binder/postBuild new file mode 100755 index 00000000..88c42e0b --- /dev/null +++ b/binder/postBuild @@ -0,0 +1,19 @@ +#!/bin/sh + +# Install and enable notebook extensions +# https://jupyter-contrib-nbextensions.readthedocs.io +jupyter contrib nbextension install --user +jupyter nbextension enable codefolding/main +jupyter nbextension enable codefolding/edit +jupyter nbextension enable --py latex_envs + +# Enable cite2c extension +python -m cite2c.install + +# Add zotero credential to notebook configuration +result=$(python < Date: Tue, 23 Jul 2019 10:50:23 -0700 Subject: [PATCH 09/19] add credential to todo --- todo.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/todo.txt b/todo.txt index 112618b5..e2d1e360 100644 --- a/todo.txt +++ b/todo.txt @@ -1,3 +1,4 @@ Check widgets are working fine in: notebooks/TractableBufferStockQuickDemo.ipynb Double check codefolding Check latex_env +hash or hide zotero credential token \ No newline at end of file From 8f0e60c15876940139cb81612d51700ef6bd0da9 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Tue, 23 Jul 2019 10:50:44 -0700 Subject: [PATCH 10/19] update instructions in README --- README.md | 20 +++----------------- 1 file changed, 3 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 857ac580..5ed44d67 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,6 @@ This repository contains demos and documentation for [HARK](https://github.com/econ-ark/HARK). -[![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/econ-ark/DemARK/master) - ## Try the notebooks on Binder **No installation is needed. Runs in a web browser** @@ -35,12 +33,14 @@ python3 -m venv myarkenv source myarkenv/bin/activate pip install --upgrade pip pip install -r requirements-local.txt +jupyter notebook ``` This will launch the jupyter file browser. The notebooks can be selected and run. -You may also wish to activate a few notebook extensions for convenience: +You may also wish to activate a few notebook extensions for convenience. First, stop Jupyter Notebook. Next add the following +at the command line: ``` # Docs on nbextensions: https://jupyter-contrib-nbextensions.readthedocs.io @@ -54,20 +54,6 @@ jupyter notebook Locally, you can enable/disable extensions by: http://localhost:8888/nbextensions - ---- - -TODO Note for Binder (Hash or hide access token) - -``` -result=$(python < Date: Tue, 23 Jul 2019 11:41:00 -0700 Subject: [PATCH 11/19] add notes after running all notebooks --- todo.md | 42 ++++++++++++++++++++++++++++++++++++++++++ todo.txt | 4 ---- 2 files changed, 42 insertions(+), 4 deletions(-) create mode 100644 todo.md delete mode 100644 todo.txt diff --git a/todo.md b/todo.md new file mode 100644 index 00000000..f16c338c --- /dev/null +++ b/todo.md @@ -0,0 +1,42 @@ +# To Do list + +## Security + +- hash or hide zotero credential token + +## Enhancements for Binder or Local use +- Add invoke to simplify for local user setup (similar to jupyterlab demo) +- Use environment.yml and conda-forge in Binder +- To Pin or not to pin requirements + +## Tests + +- Add basic tests for running notebooks success (Papermill or invoke) + +## Notebook issues + +- Check MyType error in Alternative-Combos-Of-Parameter-Values.ipynb + +### Latex Errors + +Latex errors Gentle-Intro-To-HARK-Buffer-Stock-Model nb + +### Runtime or module errors (version or logic error?) +- /srv/conda/envs/notebook/lib/python3.7/site-packages/HARK/interpolation.py:1675: RuntimeWarning: All-NaN slice encountered +- LifecycleModelExample nb error No module named 'HARK.SolvingMicroDSOPs.EstimationParameters' + +### Can't find data file + +- MicroMacroProblems Both nbs error at Lorenz cell FileNotFoundError: [Errno 2] No such file or directory: '/srv/conda/envs/notebook/lib/python3.7/site-packages/HARK/cstwMPC/USactuarial.txt' +- StructuralEstimates nb error FileNotFoundError: [Errno 2] No such file or directory: '/srv/conda/envs/notebook/lib/python3.7/site-packages/HARK/cstwMPC/USactuarial.txt' +- Uncertainty-and-Savings-Rate nb No such file or directory: '/srv/conda/envs/notebook/lib/python3.7/site-packages/HARK/cstwMPC/USactuarial.txt' + + +### Slow, Runs until student exercise + +- Check heading click for DCEGM-Upper-Envelope nb +- Check last cell execution Fashion-Victim-Model nb (It works but serializes execution) Slow +- KrusellSmith.ipynb Solver is slow... +- IncExpectation notebooks are slow... +- Runs until student exercise: Gentle-Intro-To-HARK-PerfForesightCRRA +- Runs until student exercise: Latex?? Gentle-Intro-To-HARK \ No newline at end of file diff --git a/todo.txt b/todo.txt deleted file mode 100644 index e2d1e360..00000000 --- a/todo.txt +++ /dev/null @@ -1,4 +0,0 @@ -Check widgets are working fine in: notebooks/TractableBufferStockQuickDemo.ipynb -Double check codefolding -Check latex_env -hash or hide zotero credential token \ No newline at end of file From 9c087c61aec5eb51ecbb142da0bc1958f8acf1f4 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Tue, 23 Jul 2019 11:43:38 -0700 Subject: [PATCH 12/19] remove holding directory of old binder config --- holding-dir-binder/postBuild | 12 ------------ holding-dir-binder/postBuild.bat | 11 ----------- holding-dir-binder/requirements.txt | 7 ------- holding-dir-binder/runtime.txt | 1 - 4 files changed, 31 deletions(-) delete mode 100755 holding-dir-binder/postBuild delete mode 100644 holding-dir-binder/postBuild.bat delete mode 100644 holding-dir-binder/requirements.txt delete mode 100644 holding-dir-binder/runtime.txt diff --git a/holding-dir-binder/postBuild b/holding-dir-binder/postBuild deleted file mode 100755 index 554e4544..00000000 --- a/holding-dir-binder/postBuild +++ /dev/null @@ -1,12 +0,0 @@ -#!/bin/sh -jupyter contrib nbextension install --user -jupyter nbextension enable codefolding/main -jupyter nbextension enable codefolding/edit -jupyter nbextension enable latex_envs -python -m cite2c.install -result=$(python < Date: Tue, 23 Jul 2019 11:43:54 -0700 Subject: [PATCH 13/19] clean up README --- README.md | 33 +++------------------------------ 1 file changed, 3 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 5ed44d67..2d10bddc 100644 --- a/README.md +++ b/README.md @@ -39,8 +39,9 @@ jupyter notebook This will launch the jupyter file browser. The notebooks can be selected and run. -You may also wish to activate a few notebook extensions for convenience. First, stop Jupyter Notebook. Next add the following -at the command line: +You may also wish to activate a few notebook extensions for convenience. +- First, stop Jupyter Notebook. +- Next execute the following at the command line: ``` # Docs on nbextensions: https://jupyter-contrib-nbextensions.readthedocs.io @@ -66,34 +67,6 @@ TODO Create a docker container and host on Docker Hub. --- -### Option 1: With Jupyter - -1. [Install jupyter](https://jupyter.org/install). -2. Clone `DemARK` to the folder of your choice -3. Run `pip install -r binder/requirements.txt` to install dependencies -4. Enable notebook extensions. - - **On Linux/macOS:** - - Run `binder/postBuild` in your terminal (at a shell in the binder directory, `./postBuild`) - - **On Windows:** - - Run `binder/postBuild.bat` - -5. Run `jupyter notebook` from the `DemARK` root folder. You will be prompted to open a page in your web browser. From there, you will be able to run the notebooks. -6. Run the notebook by clicking the `▶▶` button or choosing `Kernel → Restart & Run All` - -### Option 2: With Docker and repo2docker - -0. [Install Docker](https://www.docker.com/community-edition) -1. [Install `repo2docker`](https://github.com/jupyter/repo2docker#installation), using the "install from source" instructions -2. Run `jupyter repo2docker https://github.com/econ-ark/DemARK` -3. Follow the link in your terminal to the running instance of jupyter -4. Run the notebook by clicking the `▶▶` button or choosing `Kernel → Restart & Run All` - ---- - ## Contributions We are eager to encourage contributions. From 77ffd6bcd7754149db12da4f744f21908176d3f0 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Wed, 24 Jul 2019 13:05:02 -0700 Subject: [PATCH 14/19] add repo documentation --- docs/about_repo.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 docs/about_repo.md diff --git a/docs/about_repo.md b/docs/about_repo.md new file mode 100644 index 00000000..a8c4371c --- /dev/null +++ b/docs/about_repo.md @@ -0,0 +1,29 @@ +# About DemARK + +## Repo Layout + +The root of the DemARK repo contains the following: + +**Directories** + +- `binder` contains configuration for the mybinder.org service +- `docs` contains docs about the repo +- `lib` contains utilities such as progress bars +- `notebooks` contains Jupyter notebooks and Python files for different topics + +**Files** + +- README.md +- `environment.yml`: for local conda install +- `requirements.txt`: for local pip install +- `tasks.py`: configuration for invoke +- `talks.yml`: allows a repo to be configured for a particular workshop or talk. See JupyterLab demo repo for more info. + +## Binder configuration + +- The `binder` directory contains configuration for the mybinder.org service. +- If a `binder` directory is not present, mybinder.org will default to using the `environment.yml` file when launching. +- The `binder` configuration includes several files: + - `environment.yml` conda and conda-forge config for repo on binder service + - `postBuid` commands that are executed by Binder after an initial environment is set up + From 9c185cbedeeed288ff54a4f96ff64bfc385462b8 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Wed, 24 Jul 2019 13:11:11 -0700 Subject: [PATCH 15/19] move todo to docs directory --- todo.md => docs/todo.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename todo.md => docs/todo.md (100%) diff --git a/todo.md b/docs/todo.md similarity index 100% rename from todo.md rename to docs/todo.md From c072df31849a0632283ba7b39a53b07e298a0143 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Wed, 24 Jul 2019 13:14:47 -0700 Subject: [PATCH 16/19] pin to latest dev release for binder --- binder/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/binder/requirements.txt b/binder/requirements.txt index f5521789..800960f8 100644 --- a/binder/requirements.txt +++ b/binder/requirements.txt @@ -1,5 +1,5 @@ cite2c -econ-ark +econ-ark==0.10.1.dev ipywidgets jupyter jupyter_contrib_nbextensions From f4e854cbb48f4912b18fe6aa9fd8bac9949ef6ec Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Wed, 24 Jul 2019 13:30:43 -0700 Subject: [PATCH 17/19] add conda environment file and install docs --- README.md | 33 +++++++++++++++++---------------- environment.yml | 15 +++++++++++++++ 2 files changed, 32 insertions(+), 16 deletions(-) create mode 100644 environment.yml diff --git a/README.md b/README.md index 2d10bddc..726cfed6 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,7 @@ Click the Binder link. Binder builds an environment in the cloud for you to use. The first time Binder launches it may take a while since it is busy creating a container to run the demo notebooks. Subsequent launches should be quicker. -**Use this link while testing** - -[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/willingc/DemARK/troubleshoot) +[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/econ-ark/DemARK/master) ## Local installation @@ -32,19 +30,30 @@ The installation instructions are provided for Python 3.6+. python3 -m venv myarkenv source myarkenv/bin/activate pip install --upgrade pip -pip install -r requirements-local.txt +pip install -r requirements.txt +jupyter contrib nbextension install --user # installs css/js and nbconvert config info +jupyter nbextension enable codefolding/main # enable codefolding in a notebook code cell +jupyter nbextension enable codefolding/edit # enable codefolding in editor +jupyter nbextension enable --py latex_envs # enable some latex features into notebook +python3 -m cite2c.install # Enables the cite2c extension (you will need to log into zotero if you use this extension) **Optional** jupyter notebook ``` This will launch the jupyter file browser. The notebooks can be selected and run. -You may also wish to activate a few notebook extensions for convenience. -- First, stop Jupyter Notebook. -- Next execute the following at the command line: +Locally, you can enable/disable extensions by: http://localhost:8888/nbextensions. More information can be found in the [notebook extensions documentation](https://jupyter-contrib-nbextensions.readthedocs.io) + +--- + +### Option 1b: With Jupyter using conda + +Using conda from Anaconda or miniconda, enter the following to create a local +conda environment. ``` -# Docs on nbextensions: https://jupyter-contrib-nbextensions.readthedocs.io +conda env create -f environment.yml +conda activate demos jupyter contrib nbextension install --user # installs css/js and nbconvert config info jupyter nbextension enable codefolding/main # enable codefolding in a notebook code cell jupyter nbextension enable codefolding/edit # enable codefolding in editor @@ -53,14 +62,6 @@ python3 -m cite2c.install # Enables the cite2c extension (you will need to log jupyter notebook ``` -Locally, you can enable/disable extensions by: http://localhost:8888/nbextensions - ---- - -### Option 1b: With Jupyter using conda - -TODO: create an environment.yml - ### Option 2 TODO Create a docker container and host on Docker Hub. diff --git a/environment.yml b/environment.yml new file mode 100644 index 00000000..017a66b7 --- /dev/null +++ b/environment.yml @@ -0,0 +1,15 @@ +name: demos +channels: +- conda-forge +dependencies: +# Jupyter +- ipywidgets +- jupyter +- jupyter_contrib_nbextensions +# libraries +- matplotlib +- numpy +- scipy +- pip: + - cite2c + - econ-ark==0.10.1.dev \ No newline at end of file From f3980b7ab32b35658d176132890dfdfb3047e426 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Wed, 24 Jul 2019 13:35:01 -0700 Subject: [PATCH 18/19] add docker install --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 726cfed6..317421b5 100644 --- a/README.md +++ b/README.md @@ -62,11 +62,14 @@ python3 -m cite2c.install # Enables the cite2c extension (you will need to log jupyter notebook ``` -### Option 2 +### Option 2: With Docker and repo2docker -TODO Create a docker container and host on Docker Hub. +0. [Install Docker](https://www.docker.com/community-edition) +1. [Install `repo2docker`](https://github.com/jupyter/repo2docker#installation), using the "install from source" instructions +2. Run `jupyter repo2docker https://github.com/econ-ark/DemARK` +3. Follow the link in your terminal to the running instance of jupyter +4. Run the notebook by clicking the `▶▶` button or choosing `Kernel → Restart & Run All` ---- ## Contributions From fdfc496d95b1c6ab69e3e561db3e455dccf6e6b0 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Wed, 24 Jul 2019 13:41:01 -0700 Subject: [PATCH 19/19] fix typo --- binder/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/binder/requirements.txt b/binder/requirements.txt index 800960f8..a1614909 100644 --- a/binder/requirements.txt +++ b/binder/requirements.txt @@ -1,5 +1,5 @@ cite2c -econ-ark==0.10.1.dev +econ-ark==0.10.1.dev3 ipywidgets jupyter jupyter_contrib_nbextensions