Skip to content

Commit 7070624

Browse files
committed
content/installation: Add tabs for Linux/MacOS/Win and other clarifications
1 parent 4a3fced commit 7070624

File tree

1 file changed

+67
-34
lines changed

1 file changed

+67
-34
lines changed

content/installation.rst

Lines changed: 67 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -126,19 +126,25 @@ You need to Python in a way that activates conda/mamba.
126126

127127
.. group-tab:: Miniforge
128128

129-
Linux/MacOS: Each time you start a new command line terminal,
130-
you can activate Miniforge by running. This is needed so that
131-
Miniforge is usable wherever you need, but doesn't affect any
132-
other software on your computer (this is not needed if you
133-
choose "Do you wish to update your shell profile to
134-
automatically initialize conda?", but then it will always be
135-
active)::
129+
.. tabs::
136130

137-
$ source ~/miniforge3/bin/activate
131+
.. group-tab:: Linux / MacOS
138132

139-
Windows: Use the "Miniforge Prompt" to start Miniforge. This
140-
will set up everything so that ``conda`` and ``mamba`` are
141-
available.
133+
Linux/MacOS: Each time you start a new command line terminal,
134+
you can activate Miniforge by running. This is needed so that
135+
Miniforge is usable wherever you need, but doesn't affect any
136+
other software on your computer (this is not needed if you
137+
choose "Do you wish to update your shell profile to
138+
automatically initialize conda?", but then it will always be
139+
active)::
140+
141+
$ source ~/miniforge3/bin/activate
142+
143+
.. group-tab:: Windows
144+
145+
Windows: Use the "Miniforge Prompt" to start Miniforge. This
146+
will set up everything so that ``conda`` and ``mamba`` are
147+
available.
142148

143149
.. group-tab:: Anaconda
144150

@@ -168,25 +174,42 @@ software needed for this particular course.
168174
This `environment file
169175
<https://raw.githubusercontent.com/AaltoSciComp/python-for-scicomp/master/software/environment.yml>`__
170176
contains all packages needed for the course, and can be
171-
installed with (there may be lots of warning messages: this is OK
172-
if it still goes through).
177+
installed with. The following command will install an
178+
environment named ``python-for-scicomp`` (there may be lots of
179+
warning messages: this is OK if it still goes through):
180+
181+
.. tabs::
182+
183+
.. group-tab:: Linux / MacOS
184+
185+
::
186+
187+
$ mamba env create -n python-for-scicomp -f https://raw.githubusercontent.com/AaltoSciComp/python-for-scicomp/master/software/environment.yml
188+
189+
.. group-tab:: Windows
173190

174-
Linux / MacOS / Windows::
191+
::
175192

176-
$ mamba env create -f https://raw.githubusercontent.com/AaltoSciComp/python-for-scicomp/master/software/environment.yml
193+
$ mamba env create -n python-for-scicomp -f https://raw.githubusercontent.com/AaltoSciComp/python-for-scicomp/master/software/environment.yml
177194

178195
Each time you start a new command line, you need to activate
179196
miniforge and this environment:
180197

181-
Linux/MacOS::
198+
.. tabs::
182199

183-
$ source ~/miniforge3/bin/activate
184-
$ conda activate python-for-scicomp
200+
.. group-tab:: Linux / MacOS
185201

186-
Windows::
202+
::
187203

188-
$ # Start the Miniforge Prompt.
189-
$ conda activate python-for-scicomp
204+
$ source ~/miniforge3/bin/activate
205+
$ conda activate python-for-scicomp
206+
207+
.. group-tab:: Windows
208+
209+
::
210+
211+
$ # Start the Miniforge Prompt.
212+
$ conda activate python-for-scicomp
190213

191214
.. group-tab:: Anaconda
192215

@@ -235,20 +258,28 @@ most of the other tools we need).
235258
.. group-tab:: Miniforge
236259

237260
JupyterLab was instaled in the previous step. To run it, first,
238-
start the Miniforge command line interface.
261+
start the Miniforge command line interface. Remember, you may
262+
need to activate Miniforge and the environment first.
263+
264+
265+
266+
.. tabs::
267+
268+
.. group-tab:: Linux / MacOS
269+
270+
::
239271

240-
Linux/MacOS: remember, you may need to activate Miniforge and
241-
the environment first::
272+
$ source ~/miniforge3/bin/activate
273+
$ conda activate python-for-scicomp
274+
$ jupyter-lab
242275

243-
$ source ~/miniforge3/bin/activate
244-
$ conda activate python-for-scicomp
245-
$ jupyter-lab
276+
.. group-tab:: Windows
246277

247-
Windows::
278+
::
248279

249-
$ # Start the Miniforge Prompt.
250-
$ conda activate python-for-scicomp
251-
$ jupyter-lab
280+
$ # Start the Miniforge Prompt.
281+
$ conda activate python-for-scicomp
282+
$ jupyter-lab
252283

253284
.. group-tab:: Anaconda
254285

@@ -270,6 +301,8 @@ Verification of Python and JupyterLab
270301
<https://youtu.be/OEX1ss_HCHc>`__ - if you can do this, you are
271302
ready to go for day one. Your exact steps may be a bit different.
272303

304+
Remember that you need to activate the environment first - see the
305+
step above.
273306

274307
.. tabs::
275308

@@ -352,10 +385,10 @@ test in advance:
352385
* From the Anaconda Navigator:
353386

354387
.. figure:: img/installation/anaconda-prompt.png
355-
:class: with-border
388+
:class: with-border
356389

357-
From the Anaconda Navigator, you can select "environments" on the
358-
left, then click on one, then the arrow, then "Open terminal".
390+
From the Anaconda Navigator, you can select "environments" on the
391+
left, then click on one, then the arrow, then "Open terminal".
359392

360393
* From your operating system's terminal applications, if you activate
361394
Anaconda.

0 commit comments

Comments
 (0)