Skip to content

Commit bd48cc1

Browse files
committed
unfinished
1 parent 0fcbaeb commit bd48cc1

File tree

1 file changed

+51
-20
lines changed

1 file changed

+51
-20
lines changed

content/installation.md

Lines changed: 51 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,34 +3,47 @@
33
[this page is adapted from <https://aaltoscicomp.github.io/python-for-scicomp/installation/>]
44

55

6-
## Packages that we will need
7-
8-
In this course we will need **Python 3** and the following Python libraries/packages:
9-
- **jupyterlab**
10-
- **altair**
11-
- pandas (comes with altair)
12-
- vega_datasets (optional)
13-
- numpy (optional)
6+
## Choosing an installation method
7+
8+
For this course we will install an isolated environment
9+
with following dependencies:
10+
```yaml
11+
name: data-viz
12+
channels:
13+
- conda-forge
14+
dependencies:
15+
- python <= 3.12
16+
- jupyterlab
17+
- altair-all
18+
- vega_datasets
19+
- pandas
20+
- numpy
21+
```
1422
23+
If you are used to installing packages in Python and know what to do with the
24+
above `environment.yml` file, please follow your own preferred installation
25+
method.
1526

16-
## How to install Python
27+
If you are new to Python or unsure how to create isolated environments in
28+
Python from files like the `environment.yml` above, please follow the
29+
instructions below.
1730

18-
We expect you to have a working Python installation with some common libraries.
19-
**We currently recommend Miniforge, which includes the base and packages
20-
through a different, freely usable channel.** You can explore the options in
21-
the tabs below.
31+
There are very many ways to install Python and packages with pros and cons and
32+
in addition there are several operating systems with their own quirks. This
33+
can be a huge challenge for beginners to navigate. It can also difficult for
34+
instructors to give recommendations for something which will work everywhere
35+
and which everybody will like.
2236

23-
**If you are used to installing Python packages**, you can use your preferred
24-
installation method. However, we recommend to not install the above packages
25-
system-wide and never to install using administrator privileges.
26-
Below we offer several options to install Python and the required packages
27-
from the [environment.yml file](https://github.com/coderefinery/data-visualization-python/blob/main/software/environment.yml).
37+
Below we will recommend **Miniforge** since it is free, open source, general,
38+
available on all operating systems, and provides a good basis for reproducible
39+
environments. However, it does not provide a graphical user interface during
40+
installation.
2841

2942
:::{admonition} Python, conda, anaconda, miniforge, etc?
3043
:class: dropdown
3144

32-
Unfortunately there's a lot of jargon. We'll go over this in the
33-
course but here is a crash course:
45+
Unfortunately there are many options and a lot of jargon.
46+
Here is a crash course:
3447

3548
* **Python** is a programming language very commonly used in
3649
science, it's the topic of this course.
@@ -55,6 +68,24 @@ course but here is a crash course:
5568
the Anaconda channels.
5669
:::
5770

71+
72+
## How to install Python
73+
74+
We expect you to have a working Python installation with some common libraries.
75+
**We currently recommend Miniforge, which includes the base and packages
76+
through a different, freely usable channel.** You can explore the options in
77+
the tabs below.
78+
79+
**If you are used to installing Python packages**, you can use your preferred
80+
installation method.
81+
82+
83+
However, we recommend to not install the above packages
84+
system-wide and never to install using administrator privileges.
85+
Below we offer several options to install Python and the required packages
86+
from the [environment.yml file](https://github.com/coderefinery/data-visualization-python/blob/main/software/environment.yml).
87+
88+
5889
::::{tabs}
5990
:::{group-tab} Miniforge
6091
This is our recommended method - it can be used for any purpose

0 commit comments

Comments
 (0)