Skip to content

Commit 279d4d6

Browse files
committed
switched to semantic line breaks
Makes editing easier in the future.
1 parent 4c953d5 commit 279d4d6

File tree

1 file changed

+32
-10
lines changed

1 file changed

+32
-10
lines changed

README.md

Lines changed: 32 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,24 @@ In your terminal, use `git` to clone the repository locally.
2121
git clone https://github.com/ericmjl/bayesian-stats-modelling-tutorial
2222
```
2323

24-
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.
24+
Alternatively, you can download the zip file of the repository at the top of the main page of the repository.
25+
If you prefer not to use git or don't have experience with it, this a good option.
2526

2627
## 2. Download Anaconda (if you haven't already)
2728

28-
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).
29+
If you do not already have the [Anaconda distribution](https://www.anaconda.com/download/) of Python 3,
30+
go get it
31+
(note: you can also set up your project environment w/out Anaconda using `pip` to install the required packages;
32+
however Anaconda is great for Data Science and we encourage you to use it).
2933

3034
## 3. Set up your environment
3135

3236
### 3a. `conda` users
3337

34-
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.
38+
If this is the first time you're setting up your compute environment,
39+
use the `conda` package manager
40+
to **install all the necessary packages**
41+
from the provided `environment.yml` file.
3542

3643
```bash
3744
conda env create -f environment.yml
@@ -57,7 +64,8 @@ conda env update -f environment.yml
5764

5865
### 3b. `pip` users
5966

60-
Please install all of the packages listed in the `environment.yml` file manually. An example command would be:
67+
Please install all of the packages listed in the `environment.yml` file manually.
68+
An example command would be:
6169

6270
```bash
6371
pip install networkx scipy ...
@@ -74,16 +82,19 @@ If you don't want to mess around with dev-ops, click the following badge to get
7482

7583
In the terminal, execute `jupyter notebook`.
7684

77-
Navigate to the notebooks directory and open the notebook 01-Student-Probability_a_simulated_introduction.ipynb.
85+
Navigate to the notebooks directory
86+
and open the notebook `01-Student-Probability_a_simulated_introduction.ipynb`.
7887

7988
### 4b. Open your Jupyter notebook in Jupyter Lab!
8089

8190

8291
In the terminal, execute `jupyter lab`.
8392

84-
Navigate to the notebooks directory and open the notebook 01-Student-Probability_a_simulated_introduction.ipynb.
93+
Navigate to the notebooks directory
94+
and open the notebook `01-Student-Probability_a_simulated_introduction.ipynb`.
8595

86-
Now, if you're using Jupyter lab, for Notebook 2, you'll need to get ipywidgets working. The documentation is [here](https://ipywidgets.readthedocs.io/en/latest/user_install.html#installing-the-jupyterlab-extension).
96+
Now, if you're using Jupyter lab, for Notebook 2, you'll need to get ipywidgets working.
97+
The documentation is [here](https://ipywidgets.readthedocs.io/en/latest/user_install.html#installing-the-jupyterlab-extension).
8798

8899
In short, you'll need node installed & you'll need to run the following in your terminal:
89100

@@ -95,7 +106,8 @@ Launch Binder using the button at the top of this README.md. Voila!
95106

96107
### 4d. Want to view static HTML notebooks
97108

98-
If you're interested in only viewing the static HTML versions of the notebooks, the links are provided below:
109+
If you're interested in only viewing the static HTML versions of the notebooks,
110+
the links are provided below:
99111

100112
Part 1: Bayesian Data Science by Simulation
101113

@@ -114,11 +126,20 @@ Part 2: Bayesian Data Science by Probabilistic Programming
114126

115127
# Acknowledgements
116128

117-
Development of this type of material is almost always a result of years of discussions between members of a community. We'd like to thank the community and to mention several people who have played pivotal roles in our understanding the the material: Michael Betancourt, Justin Bois, Allen Downey, Chris Fonnesbeck, Jake VanderPlas. Also, Andrew Gelman rocks!
129+
Development of this type of material is almost always a result of years of discussions between members of a community.
130+
We'd like to thank the community and to mention several people who have played pivotal roles in our understanding the the material:
131+
Michael Betancourt,
132+
Justin Bois,
133+
Allen Downey,
134+
Chris Fonnesbeck,
135+
Jake VanderPlas.
136+
Also, Andrew Gelman rocks!
137+
118138

119139
# Feedback
120140

121-
Please leave feedback for us [here](https://ericma1.typeform.com/to/j88n8P)! We'll use this information to help improve the teaching and delivery of the material.
141+
Please leave feedback for us [here](https://ericma1.typeform.com/to/j88n8P)!
142+
We'll use this information to help improve the teaching and delivery of the material.
122143

123144
# data credits
124145

@@ -131,3 +152,4 @@ Further reading resources that are not specifically tied to any notebooks.
131152
- [Visualization in Bayesian workflow](https://arxiv.org/abs/1709.01449)
132153
- [PyMC3 examples gallery](http://docs.pymc.io/examples.html)
133154
- [Bayesian Analysis Recipes](https://github.com/ericmjl/bayesian-analysis-recipes)
155+
- [Communicating uncertainty about facts, numbers and science](https://royalsocietypublishing.org/doi/full/10.1098/rsos.181870)

0 commit comments

Comments
 (0)