Skip to content

Commit 95e7fd1

Browse files
authored
Update README.md
1 parent 86d405b commit 95e7fd1

File tree

1 file changed

+24
-14
lines changed

1 file changed

+24
-14
lines changed

Diff for: README.md

+24-14
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ All dates from 10:15 to 15:00.
2323
**Location:** Sölvegatan 27 (The observatory), Department of Astronomy and Theoretical Physics,
2424
Rooms _Cassiopeia_ (Monday morning; Thursday afternoon; and all Friday) or _Andromeda_.
2525

26-
The course consists of four full days: three with alternating lectures and hands-on exercises, and one day with project presentations.
27-
Lectures are available as Notebooks on this site in the [lectures](lectures) folder.
26+
The course consists of four full days: three with alternating lectures and hands-on exercises, and one
27+
day with project presentations. Lectures are available as Notebooks on this site in the [lectures](lectures) folder.
2828

2929
- Day 1. Introduction
3030
- Introduction and overview of Jupyter notebooks
@@ -62,11 +62,14 @@ If you have little experience with Python or shell programming, the following tw
6262
- https://swcarpentry.github.io/python-novice-inflammation
6363

6464

65-
## Preparations _before_ the first lecture
65+
## Preparations before the first lecture
6666

67-
1. Install [miniconda3](https://conda.io/miniconda.html) alternatively the full [anaconda3](https://www.anaconda.com/download) enviroment on your laptop (the latter is **much** larger).
68-
2. [Download](https://github.com/mlund/jupyter-course/archive/master.zip) the course material (this github repository) and unzip.
69-
3. Install and activate the `LUcompute` environment described by the file [`environment.yml`](/environment.yml) by running the following in a terminal:
67+
1. Install [miniconda3](https://conda.io/miniconda.html) alternatively the full
68+
[anaconda3](https://www.anaconda.com/download) enviroment on your laptop (the latter is **much** larger).
69+
2. [Download](https://github.com/mlund/jupyter-course/archive/master.zip) the course material
70+
(this github repository) and unzip.
71+
3. Install and activate the `LUcompute` environment described by the file [`environment.yml`](/environment.yml)
72+
by running the following in a terminal:
7073

7174
```bash
7275
conda env create -f environment.yml
@@ -77,10 +80,13 @@ If you have little experience with Python or shell programming, the following tw
7780
```
7881
Instructions for Windows:
7982
1. Install [miniconda3](https://conda.io/miniconda.html).
80-
2. [Download](https://github.com/mlund/jupyter-course/archive/master.zip) the course material (this github repository) and unzip.
83+
2. [Download](https://github.com/mlund/jupyter-course/archive/master.zip) the course material (this github repository)
84+
and unzip.
8185
3. Open the `anaconda prompt` from the start menu.
82-
4. Navigate to the folder where the course material has been unzipped (_e.g._ using `cd` to change directory and `dir` to list files in a folder).
83-
5. Install and activate the `LUcompute` environment described by the file [`environment.yml`](/environment.yml) by running the following in the `anaconda prompt`:
86+
4. Navigate to the folder where the course material has been unzipped (_e.g._ using `cd` to change directory
87+
and `dir` to list files in a folder).
88+
5. Install and activate the `LUcompute` environment described by the file [`environment.yml`](/environment.yml)
89+
by running the following in the `anaconda prompt`:
8490

8591
```bash
8692
conda env create -f environment.yml
@@ -104,10 +110,12 @@ The project work consists of three steps:
104110
Here's some [inspiration](http://nbviewer.jupyter.org/github/demotu/BMC/blob/master/notebooks/Transformation2D.ipynb).
105111
- **Deadline for project: 27/12**
106112

107-
2. A peer-review process where each student reviews and, in writing, comments on _two_ other notebooks. The review should be based on the criteria listed below and for each point, include specific suggestions for improvements.
108-
**Deadline for review: 3/1**
113+
2. A peer-review process where each student reviews and, in writing, comments on _two_ other notebooks.
114+
The review should be based on the criteria listed below and for each point, include specific
115+
suggestions for improvements. **Deadline for review: 3/1**
109116

110-
3. Notebook presentation to the class (day 4). Maximum 10 minutes per participant and do include your answer to the referee reports.
117+
3. Notebook presentation to the class (day 4). Maximum 10 minutes per participant and do include your
118+
answer to the referee reports.
111119

112120
### Notebook Requirements
113121

@@ -117,8 +125,10 @@ The project notebook _must_:
117125
- [ ] include rich documentation using Markdown, equations, tables, links, etc.
118126
- [ ] import or generate data. If generating, data should be exported to disk.
119127
- [ ] perform data operations using `numpy`, `scipy`, `pandas` or equivalent.
120-
- [ ] create plots of _publication ready_ quality. For an editorial guide on _Graphical Excellence_, see [here.](http://dx.doi.org/10/cg2g)
121-
- [ ] include instructions on how to run the notebook, include the required packages. This could be an `environment.yml` file.
128+
- [ ] create plots of _publication ready_ quality. For an editorial guide on _Graphical Excellence_,
129+
see [here.](http://dx.doi.org/10/cg2g)
130+
- [ ] include instructions on how to run the notebook, include the required packages.
131+
This could be an `environment.yml` file.
122132

123133
The project notebook _could_:
124134

0 commit comments

Comments
 (0)