From 591de058fee3b00b09def2b40ce29f15dd3c1b13 Mon Sep 17 00:00:00 2001 From: David Shean Date: Mon, 13 Nov 2023 13:13:52 -0800 Subject: [PATCH 1/5] Update README.md --- profile/README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/profile/README.md b/profile/README.md index 53a39ff..c73fb6c 100644 --- a/profile/README.md +++ b/profile/README.md @@ -3,8 +3,8 @@ > The SlideRule project offers a new paradigm for NASA archival data management – rapid processing and delivery of customizable data products, rather than hosting large volumes of derivative products. Repository organization: -* [sliderule-python](https://github.com/ICESat2-SlideRule/sliderule-python) contains example notebooks demonstrating SlideRule capabilities. Start here if you are a science user. * [sliderule](https://github.com/ICESat2-SlideRule/sliderule) contains the server-side and Python client code, along with the H5Coro driver; mostly C++ and Lua. Start here if you are interested in contributing to the development of SlideRule. +* [sliderule-python](https://github.com/ICESat2-SlideRule/sliderule-python) contains example notebooks demonstrating SlideRule capabilities. Start here if you are a science user. * [paper](https://github.com/ICESat2-SlideRule/paper) contains materials for the JOSS publication describing SlideRule (https://joss.theoj.org/papers/10.21105/joss.04982). The scalable server-side components of SlideRule run in the AWS cloud with optimized functions to read HDF5 data hosted by NASA in S3 cloud object storage. While SlideRule can be accessed by any HTTP client (e.g., curl) through GET and POST requests, the sliderule-python client provides a user-friendly API for easy interaction with SlideRule's web services. The client library returns standard Python data containers (i.e., Pandas DataFrame) and facilitates serialization with provenance metadata for reproducible science. @@ -12,5 +12,3 @@ The scalable server-side components of SlideRule run in the AWS cloud with optim SlideRule uses a plugin framework to support different NASA missions and data products. The ICESat-2 SlideRule plugin offers customizable algorithms to process the archive of low-level data products from the NASA [Ice Cloud and land Elevation Satellite-2 (ICESat-2)](https://icesat-2.gsfc.nasa.gov/) laser altimetry mission. The user defines a geographic area of interest and key processing parameters via an interactive web interface or the API, and SlideRule returns high-level surface elevation point cloud products in seconds to minutes, enabling rapid algorithm development, visualization and scientific interpretation. Additional plugins include support for sampling raster datasets like ArcticDEM, REMA, and Landsat's HLS. There is also a plugin for the GEDI mission that includes some subsetting capabilities with additional features in-progress. ![SlideRule Architecture](https://slideruleearth.io/rtd/_images/sys_block_diagram.png) - - From 3ab88b1eae4c50d1310c9c9035b65e2989901fcc Mon Sep 17 00:00:00 2001 From: JP Swinski Date: Tue, 1 Apr 2025 14:22:11 +0000 Subject: [PATCH 2/5] updated profile --- profile/README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/profile/README.md b/profile/README.md index c73fb6c..7f5be45 100644 --- a/profile/README.md +++ b/profile/README.md @@ -1,14 +1,14 @@ ## SlideRule: an open framework for on-demand processing of science data in the cloud -> The SlideRule project offers a new paradigm for NASA archival data management – rapid processing and delivery of customizable data products, rather than hosting large volumes of derivative products. +_SlideRule_ is a public web service with APIs for processing science data and returning results. It provides researchers and other data systems with low-latency access to generated data products using processing parameters supplied at the time of the request. _SlideRule_ runs in AWS us-west-2 and has access to a growing list of earth science datasets stored in S3. [Python](https://github.com/SlideRuleEarth/sliderule/tree/main/clients/python), [Node.js](https://github.com/SlideRuleEarth/sliderule/tree/main/clients/nodejs), and [Web](https://client.slideruleearth.io) clients are provided to make it easier to interact with _SlideRule_.' -Repository organization: -* [sliderule](https://github.com/ICESat2-SlideRule/sliderule) contains the server-side and Python client code, along with the H5Coro driver; mostly C++ and Lua. Start here if you are interested in contributing to the development of SlideRule. -* [sliderule-python](https://github.com/ICESat2-SlideRule/sliderule-python) contains example notebooks demonstrating SlideRule capabilities. Start here if you are a science user. -* [paper](https://github.com/ICESat2-SlideRule/paper) contains materials for the JOSS publication describing SlideRule (https://joss.theoj.org/papers/10.21105/joss.04982). +Find us at: [https://slideruleearth.io](https://slideruleearth.io) -The scalable server-side components of SlideRule run in the AWS cloud with optimized functions to read HDF5 data hosted by NASA in S3 cloud object storage. While SlideRule can be accessed by any HTTP client (e.g., curl) through GET and POST requests, the sliderule-python client provides a user-friendly API for easy interaction with SlideRule's web services. The client library returns standard Python data containers (i.e., Pandas DataFrame) and facilitates serialization with provenance metadata for reproducible science. +* [sliderule](https://github.com/ICESat2-SlideRule/sliderule): server-side and Python client code +* [sliderule-python](https://github.com/SlideRuleEarth/sliderule-python): example Jupyter notebooks and Python scripts +* [sliderule-prov-sys](https://github.com/SlideRuleEarth/sliderule-prov-sys): provisioning system code +* [sliderule-web-client](https://github.com/SlideRuleEarth/sliderule-web-client): web client code for browser-based application +* [h5coro](https://github/SlideRuleEarth/h5coro): Python implementation of HDF5 cloud-optimized read-only library +* [paper](https://github.com/SlideRuleEarth/paper): source material for the JOSS publication (https://joss.theoj.org/papers/10.21105/joss.04982) -SlideRule uses a plugin framework to support different NASA missions and data products. The ICESat-2 SlideRule plugin offers customizable algorithms to process the archive of low-level data products from the NASA [Ice Cloud and land Elevation Satellite-2 (ICESat-2)](https://icesat-2.gsfc.nasa.gov/) laser altimetry mission. The user defines a geographic area of interest and key processing parameters via an interactive web interface or the API, and SlideRule returns high-level surface elevation point cloud products in seconds to minutes, enabling rapid algorithm development, visualization and scientific interpretation. Additional plugins include support for sampling raster datasets like ArcticDEM, REMA, and Landsat's HLS. There is also a plugin for the GEDI mission that includes some subsetting capabilities with additional features in-progress. - -![SlideRule Architecture](https://slideruleearth.io/rtd/_images/sys_block_diagram.png) +![SlideRule Architecture](https://slideruleearth.io/rtd/_images/sysorg.png) From 3169bf789b25cf69962cc498ddd223b2d036051a Mon Sep 17 00:00:00 2001 From: JP Swinski Date: Tue, 1 Apr 2025 14:25:55 +0000 Subject: [PATCH 3/5] further updates to profile --- profile/README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/profile/README.md b/profile/README.md index 7f5be45..f8cc449 100644 --- a/profile/README.md +++ b/profile/README.md @@ -1,10 +1,11 @@ ## SlideRule: an open framework for on-demand processing of science data in the cloud -_SlideRule_ is a public web service with APIs for processing science data and returning results. It provides researchers and other data systems with low-latency access to generated data products using processing parameters supplied at the time of the request. _SlideRule_ runs in AWS us-west-2 and has access to a growing list of earth science datasets stored in S3. [Python](https://github.com/SlideRuleEarth/sliderule/tree/main/clients/python), [Node.js](https://github.com/SlideRuleEarth/sliderule/tree/main/clients/nodejs), and [Web](https://client.slideruleearth.io) clients are provided to make it easier to interact with _SlideRule_.' +_SlideRule_ is a public web service with APIs for processing science data in the cloud and returning results directly back to users. It provides researchers and other data systems with low-latency access to generated data products using processing parameters supplied at the time of the request. -Find us at: [https://slideruleearth.io](https://slideruleearth.io) +To learn more, visit our homepage at: [https://slideruleearth.io](https://slideruleearth.io) -* [sliderule](https://github.com/ICESat2-SlideRule/sliderule): server-side and Python client code +Here are the key repositories that make up SlideRule: +* [sliderule](https://github.com/SlideRuleEarth/sliderule): server-side and Python client code * [sliderule-python](https://github.com/SlideRuleEarth/sliderule-python): example Jupyter notebooks and Python scripts * [sliderule-prov-sys](https://github.com/SlideRuleEarth/sliderule-prov-sys): provisioning system code * [sliderule-web-client](https://github.com/SlideRuleEarth/sliderule-web-client): web client code for browser-based application From 6d26bdb0d59a32de68540a6d19fc41e95c3321f2 Mon Sep 17 00:00:00 2001 From: JP Swinski Date: Tue, 1 Apr 2025 18:31:50 +0000 Subject: [PATCH 4/5] updated system diagram --- profile/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/profile/README.md b/profile/README.md index f8cc449..f5d7493 100644 --- a/profile/README.md +++ b/profile/README.md @@ -12,4 +12,4 @@ Here are the key repositories that make up SlideRule: * [h5coro](https://github/SlideRuleEarth/h5coro): Python implementation of HDF5 cloud-optimized read-only library * [paper](https://github.com/SlideRuleEarth/paper): source material for the JOSS publication (https://joss.theoj.org/papers/10.21105/joss.04982) -![SlideRule Architecture](https://slideruleearth.io/rtd/_images/sysorg.png) +![SlideRule Architecture](https://slideruleearth.io/rtd/_images/sliderule_system.png) From df1c28489d3c524030ef4fa94e097f4d6625f452 Mon Sep 17 00:00:00 2001 From: JP Swinski Date: Wed, 2 Apr 2025 15:46:22 +0000 Subject: [PATCH 5/5] fixed typo in link address --- profile/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/profile/README.md b/profile/README.md index f5d7493..b7c3ea1 100644 --- a/profile/README.md +++ b/profile/README.md @@ -9,7 +9,7 @@ Here are the key repositories that make up SlideRule: * [sliderule-python](https://github.com/SlideRuleEarth/sliderule-python): example Jupyter notebooks and Python scripts * [sliderule-prov-sys](https://github.com/SlideRuleEarth/sliderule-prov-sys): provisioning system code * [sliderule-web-client](https://github.com/SlideRuleEarth/sliderule-web-client): web client code for browser-based application -* [h5coro](https://github/SlideRuleEarth/h5coro): Python implementation of HDF5 cloud-optimized read-only library +* [h5coro](https://github.com/SlideRuleEarth/h5coro): Python implementation of HDF5 cloud-optimized read-only library * [paper](https://github.com/SlideRuleEarth/paper): source material for the JOSS publication (https://joss.theoj.org/papers/10.21105/joss.04982) ![SlideRule Architecture](https://slideruleearth.io/rtd/_images/sliderule_system.png)