Skip to content

Commit b272f37

Browse files
Update setup instructions (remove 'conda update all') + rename environment + update environment + rename master->main branch (#148)
1 parent 37449c7 commit b272f37

File tree

5 files changed

+24
-32
lines changed

5 files changed

+24
-32
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The course uses Python 3 and some data analysis packages such as Pandas, Numpy a
1515

1616
For detailed instructions to get started on your local machine , see the [setup instructions](./setup.md).
1717

18-
In case you do not want to install everything and just want to try out the course material, use the environment setup by Binder [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jorisvandenbossche/DS-python-data-analysis/master?urlpath=lab/) and open de notebooks rightaway.
18+
In case you do not want to install everything and just want to try out the course material, use the environment setup by Binder [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jorisvandenbossche/DS-python-data-analysis/main?urlpath=lab/) and open de notebooks rightaway.
1919

2020

2121
## Contributing

environment.yml

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
1-
name: DS-python-data-analysis
1+
name: DS-python
22
channels:
33
- conda-forge
44
dependencies:
5-
- python=3.8
6-
- pandas=1.2
7-
- matplotlib>3
5+
- python=3.9
86
- ipython
97
- jupyter
108
- jupyterlab
11-
- mplleaflet
12-
- notebook
139
- numpy
10+
- pandas>=1
11+
- matplotlib>3
12+
- ipympl
13+
- mplleaflet
1414
- plotnine
1515
- pyproj
1616
- requests
1717
- seaborn
18-
- xlrd
1918
- openpyxl

index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The course uses Python 3 and some data analysis packages such as Pandas, Numpy a
3030

3131
For detailed instructions to get started on your local machine , see the [setup instructions](./setup.md).
3232

33-
In case you do not want to install everything and just want to try out the course material, use the environment setup by Binder [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jorisvandenbossche/DS-python-data-analysis/master) and open de notebooks rightaway.
33+
In case you do not want to install everything and just want to try out the course material, use the environment setup by Binder [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jorisvandenbossche/DS-python-data-analysis/main) and open de notebooks rightaway.
3434

3535
## Slides
3636

setup.md

Lines changed: 15 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@ For scientific and data analysis, we recommend to use Anaconda (or Miniconda) (<
2020

2121
### Install Anaconda
2222

23-
#### Option 1: I do not have Anaconda installed
23+
#### Option 1: I do not have Anaconda installed
2424

2525
For first time users and people not fully confident with using the command line, we advise to install Anaconda, by downloading and installing the Python 3.x version from <https://www.anaconda.com/download/>. Recent computers will require the 64-Bit installer.
2626

2727
For more detailed instructions to install Anaconda, check the [Windows](https://docs.anaconda.com/anaconda/install/windows/), [Mac](https://docs.anaconda.com/anaconda/install/mac-os/) or [linux](https://docs.anaconda.com/anaconda/install/linux/) installation tutorial.
2828

29-
**Note:** When you are already familiar to the command line and Python environments you could opt to use Miniconda instead of Anaconda and download it from <https://conda.io/miniconda.html>. The main difference is that Anaconda provides a graphical user interface (Anaconda navigator) and a whole lot of scientific packages (e.g <https://docs.anaconda.com/anaconda/packages/py3.6_win-64/>) when installing, whereas for Miniconda the user needs to install all packages using the command line. On the other hand, Miniconda requires less disk space.
29+
**Note:** When you are already familiar with the command line and Python environments you could opt to use Miniconda instead of Anaconda and download it from <https://conda.io/miniconda.html>. The main difference is that Anaconda provides a graphical user interface (Anaconda navigator) and a whole lot of scientific packages (e.g <https://docs.anaconda.com/anaconda/packages/py3.6_win-64/>) when installing, whereas for Miniconda the user needs to install all packages using the command line. On the other hand, Miniconda requires less disk space.
3030

31-
#### Option 2: I have installed Anaconda earlier
31+
#### Option 2: I have installed Anaconda earlier
3232

3333
When you already have an installation of Anaconda, you have to make sure you are working with the most recent versions. As the course is developed for Python 3, make sure you have Anaconda3 (on Windows, check Start > Programs > Anaconda3). If not, reinstall Anaconda according to the previous section.
3434

@@ -42,28 +42,21 @@ Type following command + ENTER-button (make sure you have an internet connection
4242
conda update -n root conda
4343
```
4444

45-
when finished, type (+ ENTER-button):
46-
47-
```
48-
conda update --all
49-
```
50-
5145
and respond with *Yes* by typing `y`. Packages should be updated after the completion of the command.
5246

53-
### Setup after installation
47+
### Setup after Anaconda installation
5448

5549
As not all packages we will use in the course are provided by default as part of Anaconda, we have to add the package to Anaconda to get started. As a good practice, we will create a new _conda environment_ to work with. This environment will contain the required packages on which this course depends.
5650

57-
The packages used in the course are enlisted in an [`environment.yml` file](https://raw.githubusercontent.com/jorisvandenbossche/DS-python-data-analysis/master/environment.yml). The file looks as follows:
51+
The packages used in the course are enlisted in an [`environment.yml` file](https://raw.githubusercontent.com/jorisvandenbossche/DS-python-data-analysis/main/environment.yml). The file looks as follows:
5852

5953
```
60-
name: DS-python-data-analysis
54+
name: DS-python
6155
channels:
62-
- defaults
6356
- conda-forge
6457
dependencies:
65-
- python=3.8
66-
- pandas=1.2
58+
- python=3.9
59+
- pandas>1
6760
- matplotlib>3
6861
- ipython
6962
...
@@ -74,7 +67,7 @@ The file contains information on:
7467
- `channels` to define where to download the packages from
7568
- `dependencies` contains each of the packages
7669

77-
To download the environment file, click to go to the [environment.yml](https://raw.githubusercontent.com/jorisvandenbossche/DS-python-data-analysis/master/environment.yml) online. Once opened in the browser, right-click and save the file/page on your computer. The specific text depends on your browser (`Save page as...`, `Save as...`).
70+
To download the environment file, click to go to the [environment.yml](https://raw.githubusercontent.com/jorisvandenbossche/DS-python-data-analysis/main/environment.yml) online. Once opened in the browser, right-click and save the file/page on your computer. The specific text depends on your browser (`Save page as...`, `Save as...`).
7871

7972
__WARNING !__ Make sure you save the file as `environment.yml` instead of `environment.yml.txt` which, specifically on Windows operating system, might be the default option. To do so, choose for 'save as type' _All Files_ instead of 'Text Document'.
8073

@@ -104,7 +97,7 @@ Respond with *Yes* by typing `y` when asked. Output will be printed and if no er
10497
When finished, keep the terminal window open (or reopen it). Execute the following commands to check your installation:
10598

10699
```
107-
conda activate DS-python-data-analysis
100+
conda activate DS-python
108101
ipython
109102
```
110103

@@ -156,10 +149,10 @@ With `FOLDER_PATH_TO_COURSE_MATERIAL` replaced by the path to the folder with th
156149
Activate the newly created conda environment:
157150

158151
```
159-
conda activate DS-python-data-analysis
152+
conda activate DS-python
160153
```
161154

162-
Run the `check_environment.py` script:
155+
Then, run the `check_environment.py` script:
163156

164157
```
165158
python check_environment.py
@@ -178,7 +171,7 @@ Each of the course modules is set up as a [Jupyter notebook](http://jupyter.org/
178171
* Ensure that the correct environment is activated.
179172

180173
```
181-
conda activate DS-python-data-analysis
174+
conda activate DS-python
182175
```
183176

184177
* Start a jupyter notebook server by typing
@@ -189,12 +182,12 @@ Each of the course modules is set up as a [Jupyter notebook](http://jupyter.org/
189182

190183
### Option 2: Using Anaconda Navigator
191184

192-
In the Anaconda Navigator *Home* tab, first switch to the course environment, called `DS-python-data-analysis` in the selection bar. Next, select the Launch button under the Jupyter Lab icon:
185+
In the Anaconda Navigator *Home* tab, first switch to the course environment, called `DS-python` in the selection bar. Next, select the Launch button under the Jupyter Lab icon:
193186

194187
![Navigator terminal](./img/navigator_notebook.png)
195188

196189
## Next?
197190

198191
This will open a browser window automatically. Navigate to the course directory (if not already there) and choose the `notebooks` folder to access the individual notebooks containing the course material.
199192

200-
If you require some rehearsal of python itself (and numpy), check the [python_recap](https://github.com/jorisvandenbossche/DS-python-data-analysis/tree/master/notebooks/python_recap) folder first, otherwise you can directly jump into the `pandas_0x_` notebooks.
193+
If you require some rehearsal of python itself (and numpy), check the [python_recap](https://github.com/jorisvandenbossche/DS-python-data-analysis/tree/main/notebooks/python_recap) folder first, otherwise you can directly jump into the `pandas_0x_` notebooks.

slides.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@
142142

143143
Report bugs, typo's, suggestions... as issues ([New issue](https://github.com/jorisvandenbossche/DS-python-data-analysis/issues/new)) <br>or just by mail.
144144

145-
or see the [contributing guidelines](https://github.com/jorisvandenbossche/DS-python-data-analysis/blob/master/CONTRIBUTING.md)
145+
or see the [contributing guidelines](https://github.com/jorisvandenbossche/DS-python-data-analysis/blob/main/CONTRIBUTING.md)
146146

147147

148148
---

0 commit comments

Comments
 (0)