Skip to content

Commit a23f723

Browse files
authored
Merge pull request #79 from tobyhodges/remove_custom_permalinks
make lesson suitable for teaching with locally-built (serverless) pages
2 parents 2ab75d0 + 33f67af commit a23f723

File tree

10 files changed

+31
-48
lines changed

10 files changed

+31
-48
lines changed

_episodes/01-getting-started.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ keypoints:
2020
## Use the Spyder IDE for editing and running Python.
2121

2222
* The [Anaconda package manager][anaconda] is an automated way to install the [Spyder IDE][spyder].
23-
* See [the setup instructions]({{ page.root }}/setup) for Anaconda installation instructions.
23+
* See [the setup instructions]({{ page.root }}/setup.html) for Anaconda installation instructions.
2424
* It also installs all the extra libraries it needs to run.
2525
* Once you have installed Python and the Spyder IDE requirements, open a shell and type:
2626
~~~
@@ -29,7 +29,7 @@ keypoints:
2929
{: .python}
3030
3131
* This will start The Spyder IDE.
32-
* This environment has several useful tools we can use, which you can see in different panels in the Spyder IDE. We will look into some of them.
32+
* This environment has several useful tools we can use, which you can see in different panels in the Spyder IDE. We will look into some of them.
3333
* You can change the positions and sizes of these panels to your preference, as you get to know them.
3434
3535
## Different ways of interacting with Python using Spyder
@@ -64,7 +64,7 @@ keypoints:
6464
> Spyder Editor
6565
>
6666
> This is a temporary script file.
67-
> """
67+
> """
6868
>~~~
6969
> Write the following line below these lines and press run (the green 'play' button or f5). A window might pop up asking you to specify the run settings, leave the settings as they are and press 'Run'.
7070
> What happens?
@@ -91,12 +91,11 @@ keypoints:
9191
>
9292
> To save the code, press 'file' and then 'save as'. Now give the file a name, for example 'mycode.py' and save it in a directory/folder where you know how to find it.
9393
> Look into your file system the way you usually do it. Is the file where you expect it to be?
94-
>
94+
>
9595
> {: .python}
9696
{: .challenge}
9797
9898
9999
100100
[anaconda]: https://docs.anaconda.com/anaconda/install/
101101
[spyder]: https://www.spyder-ide.org/
102-

_extras/about.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
---
2-
layout: page
32
title: About
4-
root: ..
53
---
64
{% include carpentries.html %}

_extras/design.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,25 @@
11
---
2-
layout: page
3-
title: "Lesson Design"
4-
root: ..
2+
title: Lesson Design
53
---
64

75
## Pacing and overall schedule
86

97
* Pacing: The modularity of the lesson allows instructors to select the amount of content
10-
appropriate to the needs of the learners.
8+
appropriate to the needs of the learners.
119
* Each module has 15 minutes of stretch content which may be optionally included.
12-
* There is an additional 30 minutes built into the startup time to accomodate delays.
10+
* There is an additional 30 minutes built into the startup time to accomodate delays.
1311

1412
### Possible paths through the lesson
1513

1614
#### Slow morning OR afternoon
1715
* Startup + standard library
18-
* Startup + pandas
16+
* Startup + pandas
1917

20-
#### Average speed morning OR afternoon
18+
#### Average speed morning OR afternoon
2119
* Startup + standard library + pandas
2220
* Startup + standard library + standard library stretch
2321
* Startup + pandas + pandas stretch
24-
22+
2523
#### Full day option
2624
* Startup + standard library + standard library stretch + lunch + pandas + pandas stretch
2725

@@ -40,7 +38,7 @@ appropriate to the needs of the learners.
4038

4139
### Standard library (2 hours 30 min)
4240
* 9:45: Understanding the environment and basic Python types and methods (15 min)
43-
* Familiarization with the IDE
41+
* Familiarization with the IDE
4442
* Starting/stopping the IDE run or app
4543
* Print statements & evaluation
4644
* Strings
@@ -65,7 +63,7 @@ appropriate to the needs of the learners.
6563

6664
### Pandas (1 hour)
6765
* 11:15 Introduction to pandas and Jupyter (15 min)
68-
* Importing pandas
66+
* Importing pandas
6967
* How pandas is often used
7068
* Using Jupyter notebooks
7169
* Jupyter gotchas and good practices

_extras/discuss.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
---
2-
layout: page
3-
title: "Discussion"
4-
root: ..
2+
title: Discussion
53
---
64

75
There are many ways to discuss Library Carpentry lessons:
@@ -11,4 +9,3 @@ There are many ways to discuss Library Carpentry lessons:
119
- Stay in touch with our [Topicbox Group](https://carpentries.topicbox.com/groups/discuss-library-carpentry).
1210
- Follow updates on [Twitter](https://twitter.com/LibCarpentry).
1311
- Make a suggestion or correct an error by [raising an Issue](https://github.com/LibraryCarpentry/lc-open-refine/issues).
14-

_extras/exercises.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
---
2-
layout: page
3-
title: "Further Exercises"
4-
root: ..
2+
title: Further Exercises
53
---
64
FIXME: exercises that don't fit into the regular schedule.

_extras/figures.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
---
2-
layout: page
32
title: Figures
4-
root: ..
53
---
64
{% include all_figures.html %}

_extras/guide.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
---
2-
layout: page
3-
title: "Instructors' Guide"
4-
root: ..
2+
title: Instructors' Guide
53
---
64

75
## General Notes

index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
layout: lesson
33
root: .
4+
permalink: index.html
45
---
56

67
This lesson is an introduction to programming in Python
@@ -16,7 +17,7 @@ Please note that this lesson uses Python 3 rather than Python 2.
1617
> ## Under Design
1718
>
1819
> **This lesson is currently in its early design stage;
19-
> please check [the design notes]({{ page.root }}/design/)
20+
> please check [the design notes]({{ page.root }}/design/index.html)
2021
> to see what we have so far.
2122
> Contributions are very welcome:
2223
> we would be particularly grateful for exercises
@@ -31,6 +32,6 @@ Please note that this lesson uses Python 3 rather than Python 2.
3132
>
3233
> 2. Learners must install [Anaconda](https://www.anaconda.com/download/) before the class starts.
3334
>
34-
> Please see [the setup instructions]({{ page.root }}/setup)
35+
> Please see [the setup instructions]({{ page.root }}/setup.html)
3536
> for details.
3637
{: .prereq}

reference.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
11
---
22
layout: reference
3-
root: .
43
---
5-

setup.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,17 @@
11
---
2-
layout: page
3-
title: "Setup"
4-
root: .
2+
title: Setup
53
---
64

75
## Installing Python Using Anaconda
86

9-
[Python][python] is great for general-purpose programming and is a popular language
10-
for scientific computing as well. Installing all of the packages required for this
7+
[Python][python] is great for general-purpose programming and is a popular language
8+
for scientific computing as well. Installing all of the packages required for this
119
lessons individually can be a bit difficult, however, so we recommend the all-in-one
1210
installer [Anaconda][anaconda].
1311

1412
Regardless of how you choose to install it, please make sure you install Python
15-
version 3.x (e.g., Python 3.6 version). Also, please set up your Python environment at
16-
least a day in advance of the workshop. If you encounter problems with the
13+
version 3.x (e.g., Python 3.6 version). Also, please set up your Python environment at
14+
least a day in advance of the workshop. If you encounter problems with the
1715
installation procedure, ask your workshop organizers via e-mail for assistance so
1816
you are ready to go as soon as the workshop begins.
1917

@@ -25,7 +23,7 @@ you are ready to go as soon as the workshop begins.
2523
2. Download the Python 3 installer for Windows.
2624

2725
3. Double-click the executable and install Python 3 using _MOST_ of the
28-
default settings. The only exception is to check the
26+
default settings. The only exception is to check the
2927
**Make Anaconda the default Python** option.
3028

3129
### macOS - [Video tutorial][video-mac]
@@ -39,7 +37,7 @@ you are ready to go as soon as the workshop begins.
3937

4038
### Linux
4139

42-
Note that the following installation steps require you to work from the shell.
40+
Note that the following installation steps require you to work from the shell.
4341
If you run into any difficulties, please request help before the workshop begins.
4442

4543
1. Open [anaconda.com/download][anaconda-dl] with your web browser.
@@ -64,15 +62,15 @@ If you run into any difficulties, please request help before the workshop begins
6462
d. Press enter.
6563
6664
e. Follow the text-only prompts. When the license agreement appears (a colon
67-
will be present at the bottom of the screen) hold the down arrow until the
68-
bottom of the text. Type `yes` and press enter to approve the license. Press
69-
enter again to approve the default location for the files. Type `yes` and
70-
press enter to prepend Anaconda to your `PATH` (this makes the Anaconda
65+
will be present at the bottom of the screen) hold the down arrow until the
66+
bottom of the text. Type `yes` and press enter to approve the license. Press
67+
enter again to approve the default location for the files. Type `yes` and
68+
press enter to prepend Anaconda to your `PATH` (this makes the Anaconda
7169
distribution the default Python).
7270
7371
## Starting Python
7472
75-
We will teach Python using [Spyder][spyder]. If you installed Python using Anaconda, Spyder should already be on your system. If
73+
We will teach Python using [Spyder][spyder]. If you installed Python using Anaconda, Spyder should already be on your system. If
7674
you did not use Anaconda, use the Python package manager pip
7775
(see the [Spyder website][spyder-install] for details.)
7876
@@ -83,7 +81,7 @@ $ spyder
8381
~~~
8482
{: .bash}
8583
86-
To start the Python interpreter without Spyder, open a terminal
84+
To start the Python interpreter without Spyder, open a terminal
8785
or Git Bash and type the command:
8886
8987
~~~

0 commit comments

Comments
 (0)