Skip to content

Commit

Permalink
docs: typo and readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
mdtanker committed Jun 14, 2024
1 parent 84524e3 commit c0ffc0c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 8 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,13 @@

<!-- SPHINX-START-proj-desc -->

**PolarToolkit** (formerly known as Antarctic-Plots) is a Python package to make Polar (i.e. Antarctic, Arctic, Greenland) research more efficient, reproducible, and accessible.
**PolarToolkit** (formerly known as Antarctic-Plots) is a Python package to make polar (i.e. Antarctic, Arctic, Greenland) research more efficient, reproducible, and accessible.
The software does this by providing:

- Convenient functions for downloading and pre-processing a wide range of commonly used polar datasets
- Tools for common geospatial tasks (i.e. changing data resolution, subsetting data by geographic regions)
- Code to easily create publication-quality maps, data profiles, and cross-sections

Additionally, **PolarToolkit** provides an easy means for exploring datasets with pre-defined or interactively chosen geographic regions.
- convenient functions for downloading and pre-processing a wide range of commonly used polar datasets
- tools for common geospatial tasks (i.e. changing data resolution, subsetting data by geographic regions)
- code to easily create publication-quality maps, data profiles, and cross-sections
- a means to interactively explore datasets

<!-- SPHINX-END-proj-desc -->

Expand Down
4 changes: 2 additions & 2 deletions docs/tutorial/download_data.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Download Polar data\n",
"# Download polar data\n",
"One of the main functionalities of PolarToolkit is to download datasets commonly used for polar research. There is a very simple demonstration of how this works. We will download a grid file, a shapefile, and some point data."
]
},
Expand Down Expand Up @@ -767,7 +767,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.9"
"version": "3.1.-1"
},
"vscode": {
"interpreter": {
Expand Down

0 comments on commit c0ffc0c

Please sign in to comment.