Skip to content

Commit

Permalink
Update README with correct instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
MridulS committed Nov 29, 2023
1 parent 53f533a commit 7d77bdb
Showing 1 changed file with 7 additions and 21 deletions.
28 changes: 7 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,47 +11,33 @@ Demonstrations of how to use material in the [Econ-ARK](https://github.com/econ-

### Option 1: With Jupyter

0. [Install jupyter](https://jupyter.org/install).
1. [Install Anaconda](https://docs.anaconda.com/free/anaconda/install/index.html) or [Miniconda](https://docs.conda.io/projects/miniconda/en/latest/)
1. [Install Miniconda](https://docs.conda.io/projects/miniconda/en/latest/miniconda-install.html)
2. Clone `DemARK` to the folder of your choice
3. Using Anaconda, install the environment\
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. 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`

6. 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.
7. Run the notebook by clicking the `▶▶` button or choosing `Kernel → Restart & Run All`
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](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`
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.

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.

## Issues

Open an issue in this repository!
Expand Down

0 comments on commit 7d77bdb

Please sign in to comment.