Skip to content
Demonstrations of how to use material in the Econ-ARK
Jupyter Notebook Python
Branch: master
Clone or download

Latest commit

llorracc
Latest commit 9780ef2 Feb 27, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
binder Update requirements.txt Feb 12, 2020
notebooks Fix aNrm vs aLev error Feb 27, 2020
.gitignore Ignore ipython checkpoints Mar 17, 2019
.travis.yml run travis for all notebooks Feb 25, 2020
LICENSE Initial commit Apr 19, 2018
README.md Update README.md Dec 9, 2019
requirements.txt add statsmodels Feb 24, 2020

README.md

DemARK

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

Binder Build Status

Local installation

Option 1: With Jupyter

  1. Install jupyter.

  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

  1. Install Docker
  2. Install repo2docker, using the "install from source" instructions
  3. Run jupyter repo2docker https://github.com/econ-ark/DemARK
  4. Follow the link in your terminal to the running instance of jupyter
  5. 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 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!

You can’t perform that action at this time.