Skip to content

Commit b79189f

Browse files
committed
docs(updated-some-of-the-documentation-and-added-an-installation-section): updated some of the documentation and added an installation section
1 parent 6ccfc84 commit b79189f

20 files changed

+141
-67
lines changed

_episodes/00-Installation.md

+86
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
---
2+
title: "Installation of the `galah-python` package"
3+
start: true
4+
teaching: 10
5+
exercises: 0
6+
questions:
7+
- "How do I install anaconda, galah-python and other packages for this workshop?"
8+
objectives:
9+
- "Install all packages necessary for the workshop."
10+
---
11+
12+
# Installing anaconda
13+
14+
Go to this website:
15+
16+
https://www.anaconda.com/download/success
17+
18+
and download the appropriate distribution for your OS (Mac, Windows, Linux etc.)
19+
20+
# Setting up your environment
21+
22+
## using anaconda-navigator
23+
24+
First, open the navigator and go to `Environments`.
25+
26+
![](../fig/anaconda-home.png)
27+
28+
In `Environments`, go to the `Create` button.
29+
30+
![](../fig/anaconda-environments.png)
31+
32+
Name your environment what makes sense to you. I used `galah-python-workshop` in this example.
33+
34+
![](../fig/rename-environment.png)
35+
36+
Click `Ok`, and then click on the environment.
37+
38+
## using the terminal
39+
40+
When you open your terminal, create an environment using the following command (I've used `galah-python-workshop` as the name of the environment; however, feel free to name the environment whatever makes sense to you):
41+
42+
```bash
43+
conda create -n galah-python-workshop python
44+
```
45+
46+
To acivate your conda environment, run
47+
48+
```bash
49+
conda activate galah-python-workshop
50+
```
51+
52+
# Installing `galah-python` and other packages
53+
54+
Unfortunately, I haven't gotten around to shipping `galah-python` to the `conda-forge` installer yet. However, you can install other packages via `conda-forge` if you would like.
55+
56+
## using Python Package Index (PIP)
57+
58+
First, you need to open a terminal. If this is your first time working with a terminal, awesome! You can do it from the anaconda navigator:
59+
60+
![](../fig/navigator-terminal.png)
61+
62+
when the terminal is opened, type the following into the terminal:
63+
64+
```bash
65+
pip install galah-python geopandas matplotlib jupyter
66+
```
67+
68+
For those who are used to working with a terminal, ensure that you install these in your chosen `conda` environment
69+
70+
## using anaconda-navigator
71+
72+
This example is for `matplotlib`; however, it can be done for all packages except for `galah-python`.
73+
74+
First, under your chosen environment, change the packages from `Installed` to `All`.
75+
76+
![](../fig/installed.png)
77+
78+
In the search button, search for `matplotlib`. You will get something like this:
79+
80+
![](../fig/matplotlib.png)
81+
82+
Select `matplotlib` and then click `Apply` in the lower left-hand corner. A pop-up window will come up looking like this:
83+
84+
![](../fig/popup.png)
85+
86+
Click `Apply`, and `matplotlib` will be installed, along with all its dependencies.

_episodes/00-Intro-ALA-galah.md _episodes/01-Intro-ALA-galah.md

+2-47
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "What is the ALA and the galah-python package?"
2+
title: "History of the `galah-python` package"
33
start: true
44
teaching: 10
55
exercises: 0
@@ -69,49 +69,4 @@ To ensure that the R and Python packages are as similar as possible, we structur
6969
| | `select=` | `galah.atlas_species()` |
7070
| | `group_by=` | `galah.atlas_media()` |
7171
| | `polygon=` | |
72-
| | `bbox=` | |
73-
74-
# Ok, now how do I install and use it? Are there other packages I need to install?
75-
76-
To install `galah-python`, ensure that you have the terminal open. To do this via Anaconda, go to `Environments`. Choose the environment you want, and then click the button that looks like a "Play" button. Choose `Open Terminal`.
77-
78-
In the terminal, type
79-
80-
```bash
81-
pip install galah-python
82-
```
83-
84-
You will need other packages in this workshop, namely `matplotlib` and `geopandas`. To install them, run
85-
86-
```bash
87-
pip install matplotlib geopandas
88-
```
89-
90-
Then, in the terminal, type
91-
92-
```bash
93-
python
94-
```
95-
96-
and, when you see three `>>>`, type
97-
98-
```python
99-
>>> import galah
100-
>>> import matplotlib
101-
>>> import geopandas
102-
```
103-
104-
If you get no errors, this has installed correctly.
105-
106-
Now that you have installed `galah-python`, I will take you through these two examples:
107-
108-
- How to get occurrences of the species *Litoria peronii* and plot them on a map
109-
- How to get a list of all the species in the state of Victoria (or the ACT?)
110-
111-
First, I will take you through how to build a query step by step. Before this, we need to choose our Text Editor. My preference is Jupyter Notebook. You can open this in Anaconda by clicking the "Play" button, and choosing `Open with Jupyter Notebook`. If you prefer working on the Terminal, type
112-
113-
```bash
114-
jupyter notebook
115-
```
116-
117-
and a new instance of jupyter will open in your browser.
72+
| | `bbox=` | |

_episodes/02-Link-To-Intro-Python.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: "Lesson Link for Introduction To Python"
3+
start: true
4+
teaching: 10
5+
exercises: 0
6+
questions:
7+
objectives:
8+
- "Gain basic knowledge of the Python programming language and assigning variables before starting with galah-python"
9+
keypoints:
10+
---
11+
12+
# What do you recommend as a starting point?
13+
14+
I would recommend this lesson from the Programming with Python Software Carpentries workshop:
15+
16+
https://swcarpentry.github.io/python-novice-inflammation/01-intro.html
17+
18+
In it, it covers the basics of variables and in-built Python functions, which is what you will need for this workshop
File renamed without changes.

_episodes/05-Taxonomy-Examples.md

Whitespace-only changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

_episodes/06-Making-a-Species-List.md _episodes/09-Making-a-Species-List.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Creating Species lists"
2+
title: "Creating Species Lists and Filtering by Threatened Species"
33
start: true
44
teaching: 15
55
exercises: 5

_includes/dc/schedule.html

+19-7
Original file line numberDiff line numberDiff line change
@@ -68,31 +68,43 @@ <h3>Start</h3>
6868
<table class="table table-striped">
6969
<tr> <!-- row 2 -->
7070
<td>09:30</td> <!-- time -->
71-
<td><a href="{{ site.url }}{{ site.baseurl }}/00-Intro-ALA-galah/index.html">What is the ALA?</a></td> <!-- content -->
71+
<td><a href="{{ site.url }}{{ site.baseurl }}/00-Installation/index.html">Installation</a></td> <!-- content -->
7272
</tr>
7373
<tr> <!-- row 2 -->
7474
<td>09:40</td> <!-- time -->
75-
<td><a href="{{ site.url }}{{ site.baseurl }}/01-Query-Template/index.html">Guide and template to query building in galah-python</a></td> <!-- content -->
75+
<td><a href="{{ site.url }}{{ site.baseurl }}/01-Intro-ALA-galah/index.html">A history of galah-python</a></td> <!-- content -->
7676
</tr>
7777
<tr> <!-- row 2 -->
7878
<td>09:50</td> <!-- time -->
79-
<td><a href="{{ site.url }}{{ site.baseurl }}/02-Building-An-Example-Query/index.html">Building the query "Download record counts of Peron's tree frog since 2018 in New South Wales by FrogID"</a></td> <!-- content -->
79+
<td><a href="{{ site.url }}{{ site.baseurl }}/02-Link-To-Intro-Python/index.html">Introduction to Python</a></td> <!-- content -->
80+
</tr>
81+
<tr> <!-- row 2 -->
82+
<td>09:50</td> <!-- time -->
83+
<td><a href="{{ site.url }}{{ site.baseurl }}/03-Query-Template/index.html">Guide and template to query building in galah-python</a></td> <!-- content -->
8084
</tr>
8185
<tr> <!-- row 2 -->
8286
<td>10:20</td> <!-- time -->
83-
<td><a href="{{ site.url }}{{ site.baseurl }}/03-Break/index.html">Break</a></td> <!-- content -->
87+
<td><a href="{{ site.url }}{{ site.baseurl }}/04-Taxonomy-Examples/index.html">Taxonomy Examples</a></td> <!-- content -->
8488
</tr>
8589
<tr> <!-- row 2 -->
8690
<td>10:25</td> <!-- time -->
87-
<td><a href="{{ site.url }}{{ site.baseurl }}/04-Group-By-Example/index.html">Grouping your results by fields</a></td> <!-- content -->
91+
<td><a href="{{ site.url }}{{ site.baseurl }}/05-Building-An-Example-Query/index.html">Building the query "Download record counts of Peron's tree frog since 2018 in New South Wales by FrogID"</a></td> <!-- content -->
8892
</tr>
8993
<tr> <!-- row 2 -->
9094
<td>10:45</td> <!-- time -->
91-
<td><a href="{{ site.url }}{{ site.baseurl }}/05-Make-a-Map/index.html">Making a map using your query data</a></td> <!-- content -->
95+
<td><a href="{{ site.url }}{{ site.baseurl }}/06-Break/index.html">Break</a></td> <!-- content -->
96+
</tr>
97+
<tr> <!-- row 2 -->
98+
<td>11:05</td> <!-- time -->
99+
<td><a href="{{ site.url }}{{ site.baseurl }}/07-Group-By-Example/index.html">Grouping your results by fields</a></td> <!-- content -->
100+
</tr>
101+
<tr> <!-- row 2 -->
102+
<td>11:05</td> <!-- time -->
103+
<td><a href="{{ site.url }}{{ site.baseurl }}/08-Make-a-Map/index.html">Making a map using your query data</a></td> <!-- content -->
92104
</tr>
93105
<tr> <!-- row 2 -->
94106
<td>11:05</td> <!-- time -->
95-
<td><a href="{{ site.url }}{{ site.baseurl }}/06-Making-a-Species-List/index.html">How to make a species list</a></td> <!-- content -->
107+
<td><a href="{{ site.url }}{{ site.baseurl }}/09-Making-a-Species-List/index.html">How to make a species list</a></td> <!-- content -->
96108
</tr>
97109
</table>
98110
<h3>END</h3>

_includes/dc/who.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949

5050
<p id="who">
5151
<strong>Who:</strong>
52-
The course is aimed at graduate students and other researchers.
52+
The course is aimed at those interested in getting biodiversity data through Python.
5353
<strong>
5454
You don't need to have any previous knowledge of the tools
5555
that will be presented at the workshop.

fig/anaconda-environments.png

231 KB
Loading

fig/anaconda-home.png

264 KB
Loading

fig/installed.png

235 KB
Loading

fig/matplotlib.png

207 KB
Loading

fig/navigator-terminal.png

212 KB
Loading

fig/popup.png

218 KB
Loading

fig/rename-environment.png

252 KB
Loading

index.md

+14-11
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,18 @@ layout: workshop # DON'T CHANGE THIS.
33
# More detailed instructions (including how to fill these variables for an
44
# online workshop) are available at
55
# https://carpentries.github.io/workshop-template/customization/index.html
6-
venue: "The University Club of Western Australia" # brief name of the institution that hosts the workshop without address (e.g., "Euphoric State University")
7-
address: "Hacket Entrance #1, Hacket Drive, Crawley, WA 6009" # full street address of workshop (e.g., "Room A, 123 Forth Street, Blimingen, Euphoria"), videoconferencing URL, or 'online'
6+
venue: "Virtual" # brief name of the institution that hosts the workshop without address (e.g., "Euphoric State University")
7+
address: "Virtual" # full street address of workshop (e.g., "Room A, 123 Forth Street, Blimingen, Euphoria"), videoconferencing URL, or 'online'
88
country: "au" # lowercase two-letter ISO country code such as "fr" (see https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) for the institution that hosts the workshop
99
language: "en" # lowercase two-letter ISO language code such as "fr" (see https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for the workshop
10-
latitude: "-31.975370" # decimal latitude of workshop venue (use https://www.latlong.net/)
11-
longitude: "115.823140" # decimal longitude of the workshop venue (use https://www.latlong.net)
12-
humandate: "Oct 9, 2023" # human-readable dates for the workshop (e.g., "Feb 17-18, 2020")
13-
humantime: "9:30 am - 11:30 am AWST, 1:00 pm - 3:00 pm AWST" # human-readable times for the workshop e.g., "9:00 am - 4:30 pm CEST (7:00 am - 2:30 pm UTC)"
14-
startdate: 2023-10-09 # machine-readable start date for the workshop in YYYY-MM-DD format like 2015-01-01
15-
enddate: 2023-10-09 # machine-readable end date for the workshop in YYYY-MM-DD format like 2015-01-02
10+
latitude: "" # decimal latitude of workshop venue (use https://www.latlong.net/)
11+
longitude: "" # decimal longitude of the workshop venue (use https://www.latlong.net)
12+
humandate: "Mar 20, 2025" # human-readable dates for the workshop (e.g., "Feb 17-18, 2020")
13+
humantime: "1:45 pm - 4:45 am AEST" # human-readable times for the workshop e.g., "9:00 am - 4:30 pm CEST (7:00 am - 2:30 pm UTC)"
14+
startdate: 2025-03-20 # machine-readable start date for the workshop in YYYY-MM-DD format like 2015-01-01
15+
enddate: 2025-03-20 # machine-readable end date for the workshop in YYYY-MM-DD format like 2015-01-02
1616
instructor: ["Amanda Buyan"] # boxed, comma-separated list of instructors' names as strings, like ["Kay McNulty", "Betty Jennings", "Betty Snyder"]
17-
helper: [] # boxed, comma-separated list of helpers' names, like ["Marlyn Wescoff", "Fran Bilas", "Ruth Lichterman"]
17+
helper: ["Martin Westgate"] # boxed, comma-separated list of helpers' names, like ["Marlyn Wescoff", "Fran Bilas", "Ruth Lichterman"]
1818
email: ["amanda.buyan@csiro.au","support@ala.org.au"] # boxed, comma-separated list of contact email addresses for the host, lead instructor, or whoever else is handling questions, like ["marlyn.wescoff@example.org", "fran.bilas@example.org", "ruth.lichterman@example.org"]
1919
collaborative_notes: # optional: URL for the workshop collaborative notes, e.g. an Etherpad or Google Docs document (e.g., https://pad.carpentries.org/2015-01-01-euphoria)
2020
eventbrite: # optional: alphanumeric key for Eventbrite registration, e.g., "1234567890AB" (if Eventbrite is being used)
@@ -378,7 +378,7 @@ The lesson taught in this workshop is being piloted and a precise schedule is ye
378378

379379

380380
{% comment %}
381-
SETUP
381+
SETUP
382382

383383
Delete irrelevant sections from the setup instructions. Each
384384
section is inside a 'div' without any classes to make the beginning
@@ -391,6 +391,9 @@ please preview your site before committing, and make sure to run
391391

392392
<h2 id="setup">Setup</h2>
393393

394+
<p>
395+
Installation instructions are found on the next page.
396+
</p>
394397
<p>
395398
To participate in a
396399
{% if site.carpentry == "swc" %}
@@ -439,4 +442,4 @@ during the workshop.
439442
Please check the "Setup" page of
440443
[the lesson site]({{ site.incubator_lesson_site }}) for instructions to follow
441444
to obtain the software and data you will need to follow the lesson.
442-
{% endif %}
445+
{% endif %}

0 commit comments

Comments
 (0)