Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

Project Map

THe SlideRule Earth project has a lot of moving parts and it can be difficult for new users to know where to find the code and documentation they need. This document will provide a high level overview of the different components of SlideRule and their associated code repositories and documentation trees.

Component Organization

SlideRule System Components
Jupyter Notebook
Jupyter Notebook|Lab|Hub is the expected analysis environment of researchers that want to incorporate SlideRule into their work. That doesn’t mean SlideRule can’t be used with other environments - it can; it works with any system that can issue HTTP requests and process HTTP responses. But the SlideRule project provides a Python client that makes it much easier to work with SlideRule, and on top of that, we’ve provided Python routines and examples that are designed to run in a Python Jupyter environment.
Python Client
The SlideRule Python client is a set Python modules that provide functions for making processing requests to SlideRule web services. In a Jupter environment, all interactions with SlideRule occur through the Python client. For researchers that want to use SlideRule, the Python client is likely the only part of the SlideRule system they need to know.
Web Client
The SlideRule Web Client is a single-page application distributed by AWS CloudFront that runs inside a user’s browser. Most of the functionality provided by the SlideRule Python Client is provided in the Web Client as a graphical interface. Additionally, the Web Client provides visualization and client-side exploration of the data via an SQL interface and graphing components.
CMR
SlideRule leverages NASA’s Common Metadata Repository (CMR) for querying which dataset resources (i.e. granules) need to be processed for a given processing request. When analysis scripts call SlideRule’s Python client functions and pass in time ranges and polygons that define geospatial regions, those functions typically will issue a request to CMR behind the scenes, passing through those parameters, to get a list of granules that match the criteria.
Cluster
The heart of the SlideRule system is a cluster of EC2 instances in AWS us-west-2 running Docker containers of SlideRule’s server-side code. Earth science researchers do not need to know anything about how the server-side code works in order to use SlideRule. But for developers who are interested in how the server side works, SlideRule is a framework implemented in C++/Lua consisting of a core multithreaded data processing system, and extension packages that include things like the HTTP web server, the HDF5 data access library, and the mission specific algorithms.
Earthdata Cloud
For datasets used by SlideRule, authentication and access are taken care of automatically without the user needing to provide credentials. Each dataset also has dedicated code on the SlideRule servers that handle resource querying and optimized data access.

Web Client: client.slideruleearth.io

Python Client Installation Instructions: Getting Started Guide

Python Client User’s Guide: SlideRule Reference Documentation

Python Client Examples: sliderule/clients/python/examples

Juypter Notebook Widgets: [ipysliderule.py](https://github.com/SlideRuleEarth/sliderule/blob/main/clients/python/sliderule/ipysliderule.py)

SlideRule Server Source Code: SlideRule GitHub

SlideRule Web Client Source Code: SlideRule Web Client GitHub

Repository Organization

All of the software for SlideRule is open source under the BSD 3-clause license and developed in the open on GitHub. Users and future contributors are encouraged to browse the code, fork the repositories and submit pull requests, open issues, and post discussion topics.

The SlideRule project consists of two main repositories.

Python API Reference
raster
Developers Guide
Why SlideRule