https://github.com/joshuabillson/landsatexplorer.jl

A pure Julia package for querying and downloading Landsat data.
https://github.com/joshuabillson/landsatexplorer.jl

landsat landsat-5 landsat-7 landsat-8 landsat-9 remote-sensing satellite-data satellite-imagery

Last synced: 27 days ago
JSON representation

A pure Julia package for querying and downloading Landsat data.

• Host: GitHub
• URL: https://github.com/joshuabillson/landsatexplorer.jl
• Owner: JoshuaBillson
• License: mit
• Created: 2024-02-17T09:47:23.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-05-15T02:53:10.000Z (7 months ago)
• Last Synced: 2024-11-16T00:04:26.610Z (about 1 month ago)
• Topics: landsat, landsat-5, landsat-7, landsat-8, landsat-9, remote-sensing, satellite-data, satellite-imagery
• Language: Julia
• Homepage:
• Size: 220 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# LandsatExplorer

[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://JoshuaBillson.github.io/LandsatExplorer.jl/stable/)

[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://JoshuaBillson.github.io/LandsatExplorer.jl/dev/)

[![Build Status](https://github.com/JoshuaBillson/LandsatExplorer.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/JoshuaBillson/LandsatExplorer.jl/actions/workflows/CI.yml?query=branch%3Amain)

[![Coverage](https://codecov.io/gh/JoshuaBillson/LandsatExplorer.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/JoshuaBillson/LandsatExplorer.jl)

[LandsatExplorer](https://github.com/JoshuaBillson/LandsatExplorer.jl) is a pure Julia package for querying and downloading Landsat data from the [USGS Earth Explorer](https://earthexplorer.usgs.gov/) ecosystem.

# Installation

To install this package, start the Julia REPL and open the package manager by typing `]`.

You can then install `LandsatExplorer` from the official Julia repository like so:

```

(@v1.9) pkg> add LandsatExplorer

```

# Authentication

`LandsatExplorer` needs access to your USGS Earth Explorer credentials in order to query and download

data. These are passed in via the environment variables `LANDSAT_EXPLORER_USER` and 

`LANDSAT_EXPLORER_PASS`. You can set them manually each time you run your program by calling 

`authenticate("my_username", "my_password")`, or you can set them once in your `startup.jl` configuration.

# Quick Start

```julia

using LandsatExplorer, GeoDataFrames, Dates

# Only Necessary if `LANDSAT_EXPLORER_USER` and `LANDSAT_EXPLORER_PASS` are not Already Set

authenticate("my_username", "my_password")

# Load Region of Interest From External GeoJSON or Shapefile

roi = GeoDataFrames.read("data/roi.geojson").geometry |> first

# Define Region of Interest as a Bounding Box

bb = BoundingBox((52.1, -114.4), (51.9, -114.1))

# Define Region of Interest Centered on a Point

p = Point(52.0, -114.25)

# Search For Level-2 Landsat 8 Imagery Intersecting our ROI Between August 1 2020 and September 1 2020

dates = (DateTime(2020, 8, 1), DateTime(2020, 9, 1))

results_1 = search("LANDSAT_8", 2, dates=dates, geom=roi)

# Limit Search to Scenes with no More Than 10% Clouds

results_2 = search("LANDSAT_8", 2, dates=dates, geom=roi, clouds=10)

# Retrieve Result with Lowest Cloud Cover

scene = sort(results_2, :CloudCover) |> first

# Download Scene

download_scene(scene.Name; unpack=true)

```