From b8d0612881d3a1053e134f29c43fadc0725eb92c Mon Sep 17 00:00:00 2001 From: Andy Barrett Date: Tue, 20 Feb 2024 13:53:17 -0700 Subject: [PATCH] start to reorganize Overview page --- README.md | 40 ++++++++++++++++++++++++++++++++++------ mkdocs.yml | 4 ++-- 2 files changed, 36 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 657ca4c7..10f11fc9 100644 --- a/README.md +++ b/README.md @@ -30,32 +30,60 @@

-## **Overview** +## **Welcome to `earthaccess`** -*earthaccess* is a **python library to search, download or stream NASA Earth science data** with just a few lines of code. +`earthaccess` is a python library to **search for**, and **download** or **stream** NASA Earth science data with just a few lines of code. In the age of cloud computing, the power of 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. 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. -## **Installing earthaccess** +Try it in your browser without installing anything! [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/nsidc/earthaccess/main) + + +## **Getting Started** + +### **Installing earthaccess** + +The latest release of `earthaccess` can be installed with `mamba`, `conda` or `pip`. We recommend using `mamba` because it is faster. You will need Python 3.8 or higher installed. -Install the latest release using conda +#### Using `mamba` + +```bash +mamba install -c conda-forge earthaccess +``` + +#### Using `conda` ```bash conda install -c conda-forge earthaccess ``` -Using Pip +#### Using `pip` ```bash pip install earthaccess ``` -Try it in your browser without installing anything! [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/nsidc/earthaccess/main) + +### Check `earthaccess` is installed + +This should run seamlessly (fingers-crossed). To check `earthaccess` is correctly installed you can start a python interpreter (either python or ipython) and run the following code. + +``` +$ python +Python 3.12.1 | packaged by conda-forge | (main, Dec 23 2023, 08:03:24) [GCC 12.3.0] on linux +Type "help", "copyright", "credits" or "license" for more information. +>>> import earthaccess +>>> earthaccess.__version__ +'0.8.2' +``` + +> Note: +> Your `python` and `earthaccess` versions may be different. ## **Usage** diff --git a/mkdocs.yml b/mkdocs.yml index c1905ba3..0911390b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -46,8 +46,8 @@ plugins: - "**/.ipynb_checkpoints/*" nav: - - OVERVIEW: - - "Readme": "index.md" + - Getting Started: + - "index.md" - "Getting started": "tutorials/getting-started.ipynb" - "Resources": "resources.md" - HOW-TO: