great-circle-cookbook

Great Circles in Python for Geoscience

https://github.com/projectpythia/great-circle-cookbook

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.8%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Great Circles in Python for Geoscience

Basic Info
Statistics
  • Stars: 2
  • Watchers: 1
  • Forks: 3
  • Open Issues: 4
  • Releases: 0
Created over 1 year ago · Last pushed 6 months ago
Metadata Files
Readme License Citation

README.md

Great Circle Cookbook

thumbnail

nightly-build Binder DOI

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

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

Image Source: Wolfram MathWorld

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

Cora Schneck

Contributors

Structure

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

Each section will make use of plotting to visually demonstrate concepts with matplotlib and cartopy

Working with Great Circles

This is the main section of this notebook and will cover specific details about how to understand and calculate important features in great circles.

1. Great Circle Arcs and Paths

  • Distance between Points on a Great Circle Arc
  • Convert 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

4. Intersections of Great Circles

  • Find the intersection of two great circle paths

5. Angles and Great Circles

  • Determine the acute and obtuse angle formed by two great circle paths
  • Determine the directed angle formed by two great circle paths based on an intersection point

6. Spherical Polygons and Areas

  • Calculate 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

You can either run the notebook using Binder or on your local machine.

Running on Binder

The simplest way to interact with a Jupyter Notebook is through Binder, which enables the execution of a Jupyter Book in the cloud. The details of how this works are not important for now. All you need to know is how to launch a Pythia Cookbooks chapter via Binder. Simply navigate your mouse to the top right corner of the book chapter you are viewing and click on the rocket ship icon, (see figure below), and be sure to select “launch Binder”. After a moment you should be presented with a notebook that you can interact with. I.e. you’ll be able to execute and even change the example programs. You’ll see that the code cells have no output at first, until you execute them by pressing {kbd}Shift+{kbd}Enter. Complete details on how to interact with a live Jupyter notebook are described in Getting Started with Jupyter.

Running on Your Own Machine

If you are interested in running this material locally on your computer, you will need to follow this workflow:

  1. Clone the https://github.com/ProjectPythia/great-circle-cookbook repository:

bash git clone https://github.com/ProjectPythia/great-circle-cookbook.git

  1. Move into the great-circle-cookbook directory bash cd great-circle-cookbook
  2. Create and activate your conda environment from the environment.yml file bash conda env create -f environment.yml conda activate cookbook-gc
  3. Move into the notebooks directory and start up Jupyterlab bash cd notebooks/ jupyter lab

Owner

  • Name: Project Pythia
  • Login: ProjectPythia
  • Kind: organization
  • Email: projectpythia@ucar.edu
  • Location: United States of America

Community learning resource for Python-based computing in the geosciences

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this cookbook, please cite it as below."
authors:
  - family-names: Schneck
    given-names: Cora
    orcid: https://orcid.org/0009-0009-1415-5170
    website: https://github.com/cyschneck
    affiliation: UCAR/NCAR
  - name: "Great Circle Cookbook contributors" # use the 'name' field to acknowledge organizations
    website: "https://github.com/ProjectPythia/great-circle-cookbook/graphs/contributors"
title: "Great Circle Cookbook"
abstract: "A cookbook which covers the background and mathematics of working with great circles with plotting"

GitHub Events

Total
  • Issues event: 2
  • Watch event: 1
  • Delete event: 1
  • Issue comment event: 5
  • Push event: 99
  • Pull request event: 11
Last Year
  • Issues event: 2
  • Watch event: 1
  • Delete event: 1
  • Issue comment event: 5
  • Push event: 99
  • Pull request event: 11

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 2
  • Total pull requests: 6
  • Average time to close issues: N/A
  • Average time to close pull requests: 5 days
  • Total issue authors: 1
  • Total pull request authors: 3
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.83
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 2
  • Pull requests: 6
  • Average time to close issues: N/A
  • Average time to close pull requests: 5 days
  • Issue authors: 1
  • Pull request authors: 3
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.83
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 1
Top Authors
Issue Authors
  • cyschneck (2)
Pull Request Authors
  • cyschneck (4)
  • dependabot[bot] (1)
  • jukent (1)
Top Labels
Issue Labels
Pull Request Labels
dependencies (1) github_actions (1)

Dependencies

.github/workflows/nightly-build.yaml actions
.github/workflows/publish-book.yaml actions
.github/workflows/trigger-book-build.yaml actions
.github/workflows/trigger-delete-preview.yaml actions
.github/workflows/trigger-link-check.yaml actions
.github/workflows/trigger-preview.yaml actions
.github/workflows/trigger-replace-links.yaml actions
  • actions/checkout v4 composite
  • jacobtomlinson/gha-find-replace v3 composite
  • stefanzweifel/git-auto-commit-action v5 composite
environment.yml conda
  • cartopy
  • geopy
  • jupyter-book
  • jupyterlab
  • matplotlib
  • mystmd
  • numpy
  • pip
  • pyproj
  • sphinx-pythia-theme
  • uxarray