diff --git a/.gitignore b/.gitignore index f3567622..9c446962 100644 --- a/.gitignore +++ b/.gitignore @@ -106,3 +106,4 @@ Temporary Items /.tool-versions # End of https://www.toptal.com/developers/gitignore/api/asdf +.Rproj.user diff --git a/docs/images/earthaccess_environmental_horst.jpg b/docs/images/earthaccess_environmental_horst.jpg new file mode 100644 index 00000000..6e10ba4c Binary files /dev/null and b/docs/images/earthaccess_environmental_horst.jpg differ diff --git a/docs/images/earthaccesslogo.png b/docs/images/earthaccesslogo.png new file mode 100644 index 00000000..29538527 Binary files /dev/null and b/docs/images/earthaccesslogo.png differ diff --git a/docs/index.md b/docs/index.md index 9e116b31..c8bfb9c5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,11 +1,46 @@ -# What is `earthaccess`? +![](images/earthaccesslogo.png){alt="hexagonal artwork of a pixalated earth with the word earthaccess" width="10%"} -`earthaccess` is a python library to **search for**, and **download** or **stream** NASA Earth science data with just a few lines of code. +# Welcome to `earthaccess`! -Open science only reaches its full potential if we have easy-to-use workflows that facilitate research in an inclusive, efficient and reproducible way. Unfortunately —as it stands today— scientists and students alike face a steep learning curve adapting to systems that have grown too complex and end up spending more time on the technicalities of the tools, cloud and NASA APIs than focusing on their important science. +`earthaccess` is a Python library for searching, downloading, and streaming NASA Earth science data. -During several workshops organized by [NASA Openscapes](https://nasa-openscapes.github.io/events.html), the need to provide easy-to-use tools to our users became evident. Open science is a collaborative effort; it involves people from different technical backgrounds, and the data analysis to solve the pressing problems we face cannot be limited by the complexity of the underlying systems. Therefore, providing easy access to NASA Earthdata regardless of the data storage location (hosted within or outside of the cloud) is the main motivation behind this Python library. +Learn more through a recent [poster](https://docs.google.com/presentation/d/e/2PACX-1vT8BN1C4FkHrid_eVfOwJjZzKGn9Nomb6mnDj3Nld-nD0ekzoenxQIq6Xzo9VFQsXbixCNskadBwPwM/pub#slide=id.g317ff1cef8c_1_87), [slides](https://docs.google.com/presentation/d/1K5RbQj4OKWt49kznIF9ct-cmWADlvdYA0eI7dA7_fFg/edit#slide=id.g269ad4ab477_0_691) and [video](https://www.youtube.com/watch?v=EIr3j1_wDc0)! -The library is an open source community effort under an [MIT license](LICENSE.txt). We welcome contributions to improve `earthaccess`. Please see the [Contributing Guide](contributing/index.md) to learn how to get involved. -***earthaccess*** handles authentication with [NASA's Earthdata Login (EDL)](https://urs.earthdata.nasa.gov), search using NASA's [CMR](https://cmr.earthdata.nasa.gov/search/site/docs/search/api.html) and access through [`fsspec`](https://github.com/fsspec/filesystem_spec). +## Get Started + +Using your command line, install `earthaccess` from [PyPI](https://pypi.org) using `pip`: + +``` +python -m pip install earthaccess +``` + +Or from [conda-forge](https://conda-forge.org) using `mamba` or `conda`: + +``` +mamba install earthaccess +``` + +## Why `earthaccess`? + +![*NASA Earthdata using `earthaccess` for impactful science. Art by Allison Horst and Openscapes.*](images/earthaccess_environmental_horst.jpg){alt="3-panel watercolor artwork of environmental data within mountains and streams with arrows labeled 'import' and 'earthaccess' that connect to a data analysis panel and then a communicate panel" width="100%"} + +
+ +We can use `earthaccess` to do impactful science, faster: + +- Search Data: Explore NASA's extensive collection of Earth science data. +- Access Data: Download data to your local machine or stream it directly into your Python scripts. +- Manage Credentials: Easily manage your Earthdata Login and Earthdata Cloud credentials. + +## Community + +Please join us! Contribute to our open-source community effort: + +- Contributing Guide: Learn how to contribute to `earthaccess`. +- GitHub Repository: Explore the `earthaccess` codebase. +- Contact Us: Get in touch with the `earthaccess` team. + +## Credit + +`earthaccess` is a community-driven project, built on top of several NASA APIs and libraries. This has been spearheaded by [NASA Openscapes](https://nasa-openscapes.github.io/), an open source community supporting users across the NASA Earth science data centers (Distributed Active Archive Centers (DAACs)). diff --git a/earthaccess.Rproj b/earthaccess.Rproj new file mode 100644 index 00000000..8e3c2ebc --- /dev/null +++ b/earthaccess.Rproj @@ -0,0 +1,13 @@ +Version: 1.0 + +RestoreWorkspace: Default +SaveWorkspace: Default +AlwaysSaveHistory: Default + +EnableCodeIndexing: Yes +UseSpacesForTab: Yes +NumSpacesForTab: 2 +Encoding: UTF-8 + +RnwWeave: Sweave +LaTeX: pdfLaTeX