Skip to content

Commit 62bfc92

Browse files
authored
Added more detailed instructions for setup
1 parent e6e3f8b commit 62bfc92

1 file changed

Lines changed: 24 additions & 4 deletions

File tree

README.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,23 @@ To get started, first identify whether you:
99
2. prefer to use `pipenv`, which is a package authored by Kenneth Reitz for package management with `pip` and `virtualenv`, or if you
1010
3. Do not want to mess around with dev-ops.
1111

12-
## `conda` users
12+
## 1. Clone the repository locally
13+
14+
In your terminal, use `git` to clone the repository locally.
15+
16+
```bash
17+
git clone https://github.com/ericmjl/bayesian-stats-modelling-tutorial
18+
```
19+
20+
Alternatively, you can download the zip file of the repository at the top of the main page of the repository. If you prefer not to use git or don't have experience with it, this a good option.
21+
22+
## 2. Download Anaconda (if you haven't already)
23+
24+
If you do not already have the [Anaconda distribution](https://www.anaconda.com/download/) of Python 3, go get it (note: you can also set up your project environment w/out Anaconda using `pip` to install the required packages; however Anaconda is great for Data Science and we encourage you to use it).
25+
26+
## 3. Set up your environment
27+
28+
### 3a. `conda` users
1329

1430
If this is the first time you're setting up your compute environment, use the `conda` package manager to **install all the necessary packages** from the provided `environment.yml` file.
1531

@@ -35,11 +51,15 @@ To **update the environment** based on the `environment.yml` specification file,
3551
conda env update -f environment.yml
3652
```
3753

38-
## `pipenv` users
54+
### 3b. `pip` users
3955

40-
Instructions are coming.
56+
Please install all of the packages listed in the `environment.yml` file manually. An example command would be:
57+
58+
```bash
59+
$ pip install numpy scipy networkx ...
60+
```
4161

42-
## don't want to mess with dev-ops
62+
### 3c. don't want to mess with dev-ops
4363

4464
If you don't want to mess around with dev-ops, click the following badge to get a Binder session on which you can compute and write code.
4565

0 commit comments

Comments
 (0)