README.md

DemARK

Demonstrations of how to use material in the Econ-ARK.

Local installation

Option 1: With Jupyter

1. Install Miniconda
2. Clone DemARK to the folder of your choice
3. Using conda, install the environment
   conda env create -f binder/environment.yml
   • If you already have installed the DemARK environment, you may still need to update it
     conda env update -f binder/environment.yml
4. Activate your DemARK environment:
   conda activate DemARK
5. Install JupyterLab in the DemARK environment:
   conda install jupyterlab
6. Run jupyter lab 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.
7. Run the notebook by choosing Kernel → Restart & Run All

Option 2: With Docker and repo2docker

0. Install Docker
1. Install repo2docker, 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 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.

Issues

Open an issue in this repository!

Trigger a test on demand

If you have the proper permissions and want to test whether the DemARKs work with the latest development version of HARK,

click on the last workflow run here and click the Re-run all jobs button