Skip to content

Commit

Permalink
typo fix
Browse files Browse the repository at this point in the history
  • Loading branch information
PennyHow committed Nov 9, 2024
1 parent c874ffc commit b9af23b
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
5 changes: 3 additions & 2 deletions docs/background.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,16 @@ The **GrIML** processing package is for classifying water bodies from satellite

**Project aim:** To examine ice marginal lake changes across Greenland using a multi-method and multi-sensor remote sensing approach, refined with in situ validation.


## Package structure

The **GrIML** post-processing chain follows a linear workflow. Initial rasterised binary classifications denoting water bodies can be inputted to **convert**, **filter** and **merge** into a cohesive ice marginal lake vector dataset, populated with useful **metadata** and analysed with relevant **statistical information**.

![GrIML summary workflow](https://github.com/GEUS-Glaciology-and-Climate/GrIML/blob/main/other/reporting/figures/griml_workflow_without_gee.png?raw=true)
<img src="https://github.com/GEUS-Glaciology-and-Climate/GrIML/blob/main/other/reporting/figures/griml_workflow_without_gee.png?raw=true" alt="The GrIML workflow." width="400" align="aligncenter" />

Each of these post-processing steps is contained within GrIML's modules, and called in turn to perform the entire processing chain. The `griml()` function invokes all post-processing steps.

![GrIML package structure](https://github.com/GEUS-Glaciology-and-Climate/GrIML/blob/main/other/reporting/figures/griml_package_structure.png?raw=true)
<img src="https://github.com/GEUS-Glaciology-and-Climate/GrIML/blob/main/other/reporting/figures/griml_package_structure.png?raw=true" alt="GrIML package structure." width="400" align="aligncenter" />


## Project motivation
Expand Down
8 changes: 4 additions & 4 deletions docs/tutorials-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ iml = gpd.read_file("dataverse_files/20230101-ESA-GRIML-IML-fv1.shp")
iml.plot(color="red")
```

![Basic plot example](https://github.com/GEUS-Glaciology-and-Climate/GrIML/blob/main/docs/figures/iml_basic_plot.png)
<img src="https://github.com/GEUS-Glaciology-and-Climate/GrIML/blob/main/docs/figures/iml_basic_plot.png?raw=true" alt="Basic plot example" width="400" align="aligncenter" />

```{important}
Make sure that the file path is correct in order to load the dataset correctly
Expand All @@ -98,7 +98,8 @@ iml_d["centroid"] = iml_d.geometry.centroid
iml_d["centroid"].plot(markersize=0.5)
```

![Point plot example](https://github.com/GEUS-Glaciology-and-Climate/GrIML/blob/main/docs/figures/iml_pt_plot.png)
<img src="https://github.com/GEUS-Glaciology-and-Climate/GrIML/blob/main/docs/figures/iml_pt_plot.png?raw=true" alt="Point plot example" width="400" align="aligncenter" />


## Generating statistics

Expand Down Expand Up @@ -235,6 +236,5 @@ ax.set_ylabel('Lake abundance', fontsize=14)
# Show plot
plt.show()
```
https://github.com/GEUS-Glaciology-and-Climate/GrIML/blob/main/docs/figures/iml_time_series_plot.png?raw=true

![Time-series plot example](https://github.com/GEUS-Glaciology-and-Climate/GrIML/blob/main/docs/figures/iml_time_series_plot.png)
<img src="https://github.com/GEUS-Glaciology-and-Climate/GrIML/blob/main/docs/figures/iml_time_series_plot.png?raw=true" alt="Time-seriesplot example" width="400" align="aligncenter" />

0 comments on commit b9af23b

Please sign in to comment.