Setup Notebook

CITATION.cff

@@ -1,48 +1,12 @@
 cff-version: 1.2.0
 message: "If you use this cookbook, please cite it as below."
 authors:
-  # add additional entries for each author -- see https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md
-  - family-names: Rose
-    given-names: Brian E. J.
-    orcid: https://orcid.org/0000-0002-9961-3821 # optional
-    website: https://github.com/brian-rose # optional
-    affiliation: University at Albany (State University of New York) # optional
-  - family-names: Kent
-    given-names: Julia
-    orcid: https://orcid.org/0000-0002-5611-8986
-    website: https://github.com/jukent
+  - family-names: Schneck
+    given-names: Cora
+    orcid: https://orcid.org/0009-0009-1415-5170
+    website: https://github.com/cyschneck
     affiliation: UCAR/NCAR
-  - family-names: Tyle
-    given-names: Kevin
-    orcid: https://orcid.org/0000-0001-5249-9665
-    website: https://github.com/ktyle
-    affiliation: University at Albany (State University of New York)
-  - family-names: Clyne
-    given-names: John
-    orcid: https://orcid.org/0000-0003-2788-9017
-    website: https://github.com/clyne
-    affiliation: UCAR/NCAR
-  - family-names: Camron
-    given-names: Drew
-    orcid: https://orcid.org/0000-0001-7246-6502
-    website: https://github.com/dcamron
-    affiliation: UCAR/Unidata
-  - family-names: Grover
-    given-names: Maxwell
-    orcid: https://orcid.org/0000-0002-0370-8974
-    website: https://github.com/mgrover1
-    affiliation: Argonne National Laboratory
-  - family-names: Ford
-    given-names: Robert R.
-    orcid: https://orcid.org/0000-0001-5483-4965
-    website: https://github.com/r-ford
-    affiliation: University at Albany (State University of New York)
-  - family-names: Paul
-    given-names: Kevin
-    orcid: https://orcid.org/0000-0001-8155-8038
-    website: https://github.com/kmpaul
-    affiliation: NVIDIA
-  - name: "Cookbook Template contributors" # use the 'name' field to acknowledge organizations
+  - name: "Great Circle Cookbook contributors" # use the 'name' field to acknowledge organizations
     website: "https://github.com/ProjectPythia/great-circle-cookbook/graphs/contributors"
-title: "Cookbook Template"
-abstract: "A sample cookbook description."
+title: "Great Circle Cookbook"
+abstract: "A cookbook which covers the background and mathematics of working with great circles with plotting"

README.md

@@ -1,20 +1,29 @@
 <img src="thumbnail.png" alt="thumbnail" width="300"/>
 
-# (Replace_with_your_title) Cookbook
+# Great Circle Cookbook
 
 [![nightly-build](https://github.com/ProjectPythia/great-circle-cookbook/actions/workflows/nightly-build.yaml/badge.svg)](https://github.com/ProjectPythia/great-circle-cookbook/actions/workflows/nightly-build.yaml)
 [![Binder](https://binder.projectpythia.org/badge_logo.svg)](https://binder.projectpythia.org/v2/gh/ProjectPythia/great-circle-cookbook/main?labpath=notebooks)
 [![DOI](https://zenodo.org/badge/860220270.svg)](https://zenodo.org/badge/latestdoi/860220270)
 
-This Project Pythia Cookbook covers ... (replace `...` with the main subject of your cookbook ... e.g., _working with radar data in Python_)
+This Project Pythia Cookbook covers the background and mathematics of working with great circles and, where available, this cookbook will demonstrate how to determine the features of a great circle with both existing open-source Python packages and through spherical trigonometry
+
 
 ## Motivation
 
-(Add a few sentences stating why this cookbook will be useful. What skills will you, "the chef", gain once you have reached the end of the cookbook?)
+A great circle is the largest circle that can be drawn onto a sphere (like the Earth) that is the same diameter of the sphere. Great Circle arcs connect two positions on the curved surface of a planet like Earth and are commonly used for navigation that relies on "as-the crow flies" directions like planes, ships, and satellites
+
+<p align="center">
+<img src="https://github.com/user-attachments/assets/5ffe9566-d869-4e20-bef0-f5864502b2df" width="400"/>
+</p>
+
+_Image Source: [Wolfram MathWorld](https://mathworld.wolfram.com/GreatCircle.html)_
+
+Great circles are commonly used in navigation, satellites in remote sensing, and working with coordinates on planets, but can be difficult to find resources to fully explain how to use them.
 
 ## Authors
 
-[First Author](@first-author), [Second Author](@second-author), etc. _Acknowledge primary content authors here_
+[Cora Schneck](https://github.com/cyschneck)
 
 ### Contributors
 
@@ -24,15 +33,53 @@ This Project Pythia Cookbook covers ... (replace `...` with the main subject of
 
 ## Structure
 
-(State one or more sections that will comprise the notebook. E.g., _This cookbook is broken up into two main sections - "Foundations" and "Example Workflows."_ Then, describe each section below.)
+This cookbook is broken into two main sections:
+- Foundations and Terminology
+- Working with Great Circles
+
+### Foundations and Terminology
+
+- "Great Circle Terminology": Covers the important terminology for working with and understanding great circles
+- "Coordinate Systems": Covers important terminology and functions required to understand and converted to different types of coordinate systems like Cartesian, Spherical, Polar, and Latitude/Longitude
 
-### Section 1 ( Replace with the title of this section, e.g. "Foundations" )
+Each section will make use of plotting to visually demonstrate concepts with `matplotlib` and `cartopy`
 
-(Add content for this section, e.g., "The foundational content includes ... ")
+### Working with Great Circles
 
-### Section 2 ( Replace with the title of this section, e.g. "Example workflows" )
+This is the main section of this notebook and will cover specific details about how to understand and calculate important features in great circles.
 
-(Add content for this section, e.g., "Example workflows include ... ")
+#### 1. **Great Circle Arcs and Paths**
+- Distance between Points on a Great Circle Arc
+- Spherical Distance to Degrees
+- Determine the Bearing of a Great Circle Arc
+- Generate a Great Circle Arc with Intermediate Points
+- Determine the Midpoint of a Great Circle Arc
+- Generate a Great Circle Path
+- Determine an Antipodal Point
+
+#### 2. **Great Circles and a Point**
+- Determine the distance of a point to a great circle arc (cross-track and along-track distance)
+- Determine if a point lies on a great circle arc and path (with and without tolerances)
+
+#### 3. **Great Circles and Parallels**
+- Determine the maximum latitude on a Great Circle Path
+- Determine the minimum latitude on a Great Great path
+- Determine when a great circle path crosses parallels
+
+#### 4. **Intersections of Great Circles**
+- Find the intersection of two great circle paths (always exists)
+- Find the intersection of two great circle arcs (if it exists)
+
+#### 5. **Angles and Great Circles**
+- Calculate the acute and obtuse angle of two Great Circle paths
+- Calculate the Directed Angle of two Great Circle paths based on an intersection point
+- Working with Spherical Triangles formed by great circle arcs
+
+#### 6. **Spherical Polygons and Areas**
+- Determine clockwise/counterclockwise ordering of points on spherical polygon
+- Area and Permieter of quadrilateral patch on a unit sphere
+- Determine if a given point is within a spherical polygon
+- Mean center of spherical polygon
 
 ## Running the Notebooks
 
@@ -59,22 +106,20 @@ Jupyter](https://foundations.projectpythia.org/foundations/getting-started-jupyt
 
 If you are interested in running this material locally on your computer, you will need to follow this workflow:
 
-(Replace "cookbook-example" with the title of your cookbooks)
-
-1. Clone the `https://github.com/ProjectPythia/cookbook-example` repository:
+1. Clone the `https://github.com/ProjectPythia/great-circle-cookbook` repository:
 
    ```bash
-    git clone https://github.com/ProjectPythia/cookbook-example.git
+    git clone https://github.com/ProjectPythia/great-circle-cookbook.git
    ```
 
-1. Move into the `cookbook-example` directory
+1. Move into the `great-circle-cookbook` directory
    ```bash
-   cd cookbook-example
+   cd great-circle-cookbook
    ```
 1. Create and activate your conda environment from the `environment.yml` file
    ```bash
    conda env create -f environment.yml
-   conda activate cookbook-example
+   conda activate cookbook-gc
    ```
 1. Move into the `notebooks` directory and start up Jupyterlab
    ```bash

_gallery_info.yml

@@ -1,6 +1,14 @@
 thumbnail: thumbnail.png
 tags:
   domains:
-    - sampledomain
+    - great circle
+    - geodesic
+    - spherical trigonometry
+    - remote sensing
   packages:
-    - samplepackage
+    - numpy
+    - uxarray
+    - geopy
+    - pyproj
+    - matplotlib
+    - cartopy

_toc.yml

@@ -4,6 +4,15 @@ parts:
   - caption: Preamble
     chapters:
       - file: notebooks/how-to-cite
-  - caption: Introduction
+  - caption: Foundations
     chapters:
-      - file: notebooks/notebook-template
+      - file: notebooks/foundations/1_terminology
+      - file: notebooks/foundations/2_coordinates
+  - caption: Tutorials
+    chapters:
+      - file: notebooks/tutorials/1_arc_path
+      - file: notebooks/tutorials/2_arc_to_point
+      - file: notebooks/tutorials/3_parallels_max_min
+      - file: notebooks/tutorials/4_path_intersection
+      - file: notebooks/tutorials/5_angles
+      - file: notebooks/tutorials/6_polygon_area

environment.yml

@@ -1,7 +1,16 @@
-name: cookbook-dev
+name: cookbook-gc
 channels:
   - conda-forge
 dependencies:
   - jupyter-book
   - jupyterlab
   - sphinx-pythia-theme
+  - numpy
+  - uxarray
+  - geopy
+  - pyproj
+  - matplotlib
+  - cartopy
+  - pip
+  - pip:
+      - jupyterlab-myst