Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

First steps for 2023 #161

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

First steps for 2023 #161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
41b8e9d
add better instructions for future teachers to readme
christophfink Feb 21, 2023
1bd11f6
formatting
christophfink Feb 21, 2023
36b5456
first steps for 2023
christophfink Aug 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
39 changes: 22 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,20 +103,32 @@ few days to get everything set up.
you want to stick with the previous version, as some of the packages
might not have been updated in time.

3. Update the docker image for the *CSC Notebooks*, and upload it to CSC’s registry.
3. **Update the docker image** for the *CSC Notebooks*, and upload it to CSC’s registry.
Create a *CSC Notebooks* ‘workspace’ and ‘application’ using the docker image.
[Follow the instructions in the `Automating-GIS-processes/csc-notebook-dockerfile`
repository](https://github.com/Automating-GIS-processes/csc-notebook-dockerfile)

4. Set up Slack TODO

5. Set up GitHub classroom TODO (make new org, create per-exercise repository)

6. Update the course details defined in [`conf.py`](docs/conf.py). Things that
change every year are set up as ‘substitutions’, variables that are replaced
throughout all documents. Edit them to reflect this year’s course’s details
(as of October 2022, this block is starting [at line 42 of
`conf.py`](docs/conf.py#L42)):
4. **Set up Slack**: Create a new Slack instance, e.g.,
‘Automating-GIS-processes-2023’, and set up the channel structure such as in
previous years: `#general` and `#random` exist by default, create `#week1`
through `#week7`, as well as `#final-assignments`; create `#instructors` to
coordinate with the student tutors. *I (@christophfink) will leave the 2022
version around, drop me a line and I’ll add you there so you can see for what
we used Slack*.

5. **Set up GitHub classroom**: register for GitHub Education
(https://classroom.github.com), create a new organisation for this year’s
exercise repository templates (see
[Automating-GIS-processes-2022](https://github.com/Automating-GIS-processes-2022),
and add the exercise repositories there, one by one, as the course advances.
For each exercise, create a classroom, and update the links in the respective
`docs/lesson-X/exercise-X.md` files.

6. **Update the course details** defined in [`conf.py`](docs/conf.py). Things that
change every year are set up as ‘substitutions’, variables that are replaced
throughout all documents. Edit them to reflect this year’s course’s details
(as of October 2022, this block is starting [at line 42 of
`conf.py`](docs/conf.py#L42)):

```
# The following are the main things that need to be updated every year
Expand All @@ -133,13 +145,6 @@ throughout all documents. Edit them to reflect this year’s course’s details

<!--
TODO: Add instructions for future teachers of this course:
- How to set up GitHub class rooms
- How to update the documents (including setting the
substitution-variable in conf.py)
- How to set up Slack, and where to change the links
- How to update the dependencies at the beginning of a new year,
and how to lock them to certain versions
- How to locally install the dependencies using a virtual env, or conda env
- How to regenerate the docs locally
- How to fork the repository, and use merge requests as a way to test
changes before going live
Expand Down
6 changes: 3 additions & 3 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = "Automating GIS Processes"
version = "2022"
release = "2022"
version = "2023"
release = "2023"

author = "Henrikki Tenkanen, Vuokko Heikinheimo, Håvard Wallin Aagesen, Christoph Fink"
copyright = f"2016-{version}"
Expand Down Expand Up @@ -45,7 +45,7 @@
# These variables are replaced throughout the course documents
# (see the comment for the first item for an example)
myst_substitutions = {
"year": "2022", # use {{year}} in markdown files to replace it with the current value
"year": "2023", # use {{year}} in markdown files to replace it with the current value
"starting_date": "Tuesday, 1 November 2022",
"lectures_weekday_time_location": "Tuesday, 15:15-16:45, Exactum C222",
"work_sessions_weekday_time_location": "Friday, 12:15-16:00, Physicum A113+A114 (GIS lab)",
Expand Down
164 changes: 82 additions & 82 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,88 +138,88 @@ course-info/resources
course-info/license
```

```{toctree}
---
caption: Lesson 1
maxdepth: 2
---
lessons/lesson-1/overview
lessons/lesson-1/course-motivation
lessons/lesson-1/geometry-objects
lessons/lesson-1/exercise-1
```

```{toctree}
---
caption: Lesson 2
maxdepth: 2
---
lessons/lesson-2/overview
lessons/lesson-2/key-concepts
lessons/lesson-2/managing-file-paths
lessons/lesson-2/vector-data-io
lessons/lesson-2/geopandas-an-introduction
lessons/lesson-2/map-projections
lessons/lesson-2/exercise-2
```

```{toctree}
---
caption: Lesson 3
maxdepth: 2
---
lessons/lesson-3/overview
lessons/lesson-3/geocoding
lessons/lesson-3/geocoding-in-geopandas
lessons/lesson-3/point-in-polygon-queries
lessons/lesson-3/intersect
lessons/lesson-3/spatial-join
lessons/lesson-3/exercise-3
```

```{toctree}
---
caption: Lesson 4
maxdepth: 2
---
lessons/lesson-4/overview
lessons/lesson-4/overlay-analysis
lessons/lesson-4/vector-data-aggregating
lessons/lesson-4/simplifying-geometries
lessons/lesson-4/reclassifying-data
lessons/lesson-4/exercise-4
```

```{toctree}
---
caption: Lesson 5
maxdepth: 2
---
lessons/lesson-5/overview
lessons/lesson-5/static-maps
lessons/lesson-5/interactive-maps
lessons/lesson-5/exercise-5
```

```{toctree}
---
caption: Lesson 6
maxdepth: 2
---
lessons/lesson-6/overview
lessons/lesson-6/retrieve-data-from-openstreetmap
lessons/lesson-6/network-analysis
```

```{toctree}
---
caption: Final Assignment
maxdepth: 2
---
final-assignment/final-assignment
final-assignment/final-assignment-grading
final-assignment/final-assignment-hints
```
%```{toctree}
%---
%caption: Lesson 1
%maxdepth: 2
%---
%lessons/lesson-1/overview
%lessons/lesson-1/course-motivation
%lessons/lesson-1/geometry-objects
%lessons/lesson-1/exercise-1
%```

%```{toctree}
%---
%caption: Lesson 2
%maxdepth: 2
%---
%lessons/lesson-2/overview
%lessons/lesson-2/key-concepts
%lessons/lesson-2/managing-file-paths
%lessons/lesson-2/vector-data-io
%lessons/lesson-2/geopandas-an-introduction
%lessons/lesson-2/map-projections
%lessons/lesson-2/exercise-2
%```

%```{toctree}
%---
%caption: Lesson 3
%maxdepth: 2
%---
%lessons/lesson-3/overview
%lessons/lesson-3/geocoding
%lessons/lesson-3/geocoding-in-geopandas
%lessons/lesson-3/point-in-polygon-queries
%lessons/lesson-3/intersect
%lessons/lesson-3/spatial-join
%lessons/lesson-3/exercise-3
%```

%```{toctree}
%---
%caption: Lesson 4
%maxdepth: 2
%---
%lessons/lesson-4/overview
%lessons/lesson-4/overlay-analysis
%lessons/lesson-4/vector-data-aggregating
%lessons/lesson-4/simplifying-geometries
%lessons/lesson-4/reclassifying-data
%lessons/lesson-4/exercise-4
%```

%```{toctree}
%---
%caption: Lesson 5
%maxdepth: 2
%---
%lessons/lesson-5/overview
%lessons/lesson-5/static-maps
%lessons/lesson-5/interactive-maps
%lessons/lesson-5/exercise-5
%```

%```{toctree}
%---
%caption: Lesson 6
%maxdepth: 2
%---
%lessons/lesson-6/overview
%lessons/lesson-6/retrieve-data-from-openstreetmap
%lessons/lesson-6/network-analysis
%```

%```{toctree}
%---
%caption: Final Assignment
%maxdepth: 2
%---
%final-assignment/final-assignment
%final-assignment/final-assignment-grading
%final-assignment/final-assignment-hints
%```

% ```{toctree}
% ---
Expand Down