Skip to content

Commit

Permalink
New index layout!
Browse files Browse the repository at this point in the history
  • Loading branch information
natgeo-wong committed Mar 1, 2024
1 parent 6fbc7b6 commit 41a301e
Showing 1 changed file with 38 additions and 22 deletions.
60 changes: 38 additions & 22 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,41 @@
# [GeoRegions.jl](https://github.com/JuliaClimate/GeoRegions.jl)
*Extract Regional Data from a Gridded Dataset*

`GeoRegions.jl` is a Julia package that aims to streamline the following processes:
* query if a point / grid is within a specified boundary
* extract point data (given coordinates) from a given region
* extract regional data from a gridded dataset, or from a parent region dataset

The new core functionality of GeoRegions.jl (newly developed in v2), are the `GeoRegion` and `RegionInfo` supertypes, which contains information
* `GeoRegion`: regarding the shape and bounds of a given GeoRegion
* `RegionGrid`: needed to extract information from a lon-lat grid typical of climate datasets, such as Reanalysis data, GCM model output, satellite observations, etc.
```@raw html
---
layout: home
hero:
name: "GeoRegions.jl"
text: "Document your code"
tagline: Defining Geographic Regions for Data Extraction and Analysis
image:
src: /assets/logo.png
alt: GeoRegions
actions:
- theme: brand
text: Getting Started
link: /georegions/intro
- theme: alt
text: Tutorials
link: /using/isin
- theme: alt
text: View on Github
link: https://github.com/juliaclimate/GeoRegions.jl
features:
- icon: <img width="64" height="64" src="https://img.icons8.com/arcade/64/markdown.png" alt="markdown"/>
title: GeoRegions
details: Define your own custom Geographic Regions
link: /georegions/intro
- icon: <img width="64" height="64" src="https://img.icons8.com/arcade/64/markdown.png" alt="markdown"/>
title: Extract Data
details: Data Extraction made easy using GeoRegions.jl
link: /using/extract
- icon: <img width="64" height="64" src="https://img.icons8.com/arcade/64/markdown.png" alt="markdown"/>
title:
details: Preset Geographic Regions included
link: /lists/default
---
```

## Installation Instructions

Expand All @@ -28,16 +55,5 @@ And if you want to get the latest release without waiting for me to update the J
(@v1.6) pkg> add GeoRegions#main
```

## Documentation Overview

The documentation for `GeoRegions.jl` is divided into four components:
1. Introduction - meant as an introduction to the package, the concept of `GeoRegion`, and how to create/manipulate them
2. Tutorials - meant to show how `GeoRegion`s work, and how they can be used to extract data
3. How-to Examples - geared towards those looking for specific examples of what can be done
4. API Reference - comprehensive summary of all exported functionalities

!!! tip "Obtaining Example Datasets"
All the output for the coding examples were produced using my computer with key security information (such as login info) omitted. The examples cannot be run online because the file size requirements are too big. Copying and pasting the code examples (with relevant directory and login information changes) should produce the same results.

## Getting help
If you are interested in using `GeoRegions.jl` or are trying to figure out how to use it, please feel free to ask me questions and get in touch! Please feel free to [open an issue](https://github.com/JuliaClimate/GeoRegions.jl/issues/new) if you have any questions, comments, suggestions, etc!

0 comments on commit 41a301e

Please sign in to comment.