DemARK
This repository contains demos and documentation for HARK.
Local installation
Option 1: With Jupyter
-
Clone
DemARK
to the folder of your choice -
Run
pip install -r binder/requirements.txt
to install dependencies -
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
-
Run
jupyter notebook
from theDemARK
root folder. You will be prompted to open a page in your web browser. From there, you will be able to run the notebooks. -
Run the notebook by clicking the
▶▶
button or choosingKernel → Restart & Run All
Option 2: With Docker and repo2docker
- Install Docker
- Install
repo2docker
, using the "install from source" instructions - Run
jupyter repo2docker https://github.com/econ-ark/DemARK
- Follow the link in your terminal to the running instance of jupyter
- Run the notebook by clicking the
▶▶
button or choosingKernel → 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 with contributors to be conducted after the installation of the jupytext 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.
Issues
Open an issue in this repository!