Skip to content

Commit

Permalink
V3.4.2 webpage
Browse files Browse the repository at this point in the history
  • Loading branch information
imohamme committed Apr 17, 2023
1 parent 2263a03 commit 744a098
Show file tree
Hide file tree
Showing 25 changed files with 167 additions and 146 deletions.
11 changes: 5 additions & 6 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,9 @@ On a local machine the user should have installed the following programs as well

- *NASAaccess* R package needs a user registration access with [Earthdata](https://www.earthdata.nasa.gov/). Users should set up a registration account(s) with [Earthdata](https://www.earthdata.nasa.gov/) login as well as well as authorizing [NASA](https://www.nasa.gov/ "The National Aeronautics and Space Administration") [GES DISC](https://disc.gsfc.nasa.gov/) data access. Please refer to <https://disc.gsfc.nasa.gov/data-access> for further details.

- Installing [*curl*](https://curl.se/) software . Since Mac users have [*curl*](https://curl.se/) as part of macOS build, Windows users should make sure that their local machines build have [*curl*](https://curl.se/) installed properly.
- [*curl*](https://curl.se/) software . Since Mac users have [*curl*](https://curl.se/) as part of macOS build, Windows users should make sure that their local machines build have [*curl*](https://curl.se/) installed properly.

- Checking if you can run [*curl*](https://curl.se/) from your command prompt. Type `curl --help` and you should see the help pages for the [*curl*](https://curl.se/) program once everything is defined correctly.
- Checking if you can run [*curl*](https://curl.se/) from your command prompt. Type `curl --help` and you should see the help pages for the [*curl*](https://curl.se/) program once everything is defined correctly.

- Within Rstudio or R terminal run the following commands to install *NASAaccess*:

Expand All @@ -67,13 +67,12 @@ On a local machine the user should have installed the following programs as well

- `library(NASAaccess)`

Within the Rstudio help tab the user can verify that the package has been installed and browse the help pages of the various functions of *NASAaccess*.
Within the Rstudio help tab the user can verify that the package has been installed and browse the help pages of the various functions of *NASAaccess*. The [GES DISC](https://disc.gsfc.nasa.gov/) user registration access logging information will be processed by masking (i.e., not displaying the lieteral typed text as input) on most but not all platforms. Without providing [GES DISC](https://disc.gsfc.nasa.gov/) user registration access logging information, the user will receive '*You need to provide your Earthdata GES DISC login to proceed...*' message.

### **Conda Package**
- *NASAaccess* conda package needs a user registration access with [Earthdata](https://www.earthdata.nasa.gov/). Users should set up a registration account(s) with [Earthdata](https://www.earthdata.nasa.gov/) login as well as well as authorizing [NASA](https://www.nasa.gov/ "The National Aeronautics and Space Administration") [GES DISC](https://disc.gsfc.nasa.gov/) data access. Please refer to <https://disc.gsfc.nasa.gov/data-access> for further details.

- After registration with [Earthdata](https://www.earthdata.nasa.gov/) *NASAaccess* software package users should create a reference file (*.netrc*) with [Earthdata](https://www.earthdata.nasa.gov/) credentials stored in it to streamline the retrieval access from [NASA](https://www.nasa.gov/ "The National Aeronautics and Space Administration") servers.

- Creating the *.netrc* file at the user machine *Home* directory and storing the user [NASA](https://www.nasa.gov/ "The National Aeronautics and Space Administration") [GES DISC](https://disc.gsfc.nasa.gov/) logging information in it is needed to execute the *NASAaccess* package commands. Accessing data from NASA servers is further explained at [Here](https://wiki.earthdata.nasa.gov/display/EL/How+To+Access+Data+With+cURL+And+Wget).
- Creating the *.netrc* file at the user machine *Home* directory and storing the user [NASA](https://www.nasa.gov/ "The National Aeronautics and Space Administration") [GES DISC](https://disc.gsfc.nasa.gov/) logging information in it is done automatically to execute the *NASAaccess* package commands. Accessing data from NASA servers is further explained at [Here](https://wiki.earthdata.nasa.gov/display/EL/How+To+Access+Data+With+cURL+And+Wget). The [GES DISC](https://disc.gsfc.nasa.gov/) user registration access logging information will be processed by masking in the terminal on any major OS. Without providing [GES DISC](https://disc.gsfc.nasa.gov/) user registration access logging information, the user will receive '*You need to provide your Earthdata GES DISC login to proceed...*' message.


- To install *NASAaccess* package in a conda environment run the following:
Expand Down
44 changes: 29 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,15 +81,15 @@ local machine:
[GES DISC](https://disc.gsfc.nasa.gov/) data access. Please refer to
<https://disc.gsfc.nasa.gov/data-access> for further details.

- Installing [*curl*](https://curl.se/) software . Since Mac users have
- [*curl*](https://curl.se/) software . Since Mac users have
[*curl*](https://curl.se/) as part of macOS build, Windows users
should make sure that their local machines build have
[*curl*](https://curl.se/) installed properly.

- Checking if you can run [*curl*](https://curl.se/) from your command
prompt. Type `curl --help` and you should see the help pages for the
[*curl*](https://curl.se/) program once everything is defined
correctly.
- Checking if you can run [*curl*](https://curl.se/) from your command
prompt. Type `curl --help` and you should see the help pages for the
[*curl*](https://curl.se/) program once everything is defined
correctly.

- Within Rstudio or R terminal run the following commands to install
*NASAaccess*:
Expand All @@ -102,24 +102,38 @@ local machine:

Within the Rstudio help tab the user can verify that the package has
been installed and browse the help pages of the various functions of
*NASAaccess*.
*NASAaccess*. The [GES DISC](https://disc.gsfc.nasa.gov/) user
registration access logging information will be processed by masking
(i.e., not displaying the lieteral typed text as input) on most but not
all platforms. Without providing [GES DISC](https://disc.gsfc.nasa.gov/)
user registration access logging information, the user will receive
*You need to provide your Earthdata GES DISC login to proceed…*
message.

### **Conda Package**

- After registration with [Earthdata](https://www.earthdata.nasa.gov/)
*NASAaccess* software package users should create a reference file
(*.netrc*) with [Earthdata](https://www.earthdata.nasa.gov/)
credentials stored in it to streamline the retrieval access from
- *NASAaccess* conda package needs a user registration access with
[Earthdata](https://www.earthdata.nasa.gov/). Users should set up a
registration account(s) with
[Earthdata](https://www.earthdata.nasa.gov/) login as well as well as
authorizing
[NASA](https://www.nasa.gov/ "The National Aeronautics and Space Administration")
servers.
[GES DISC](https://disc.gsfc.nasa.gov/) data access. Please refer to
<https://disc.gsfc.nasa.gov/data-access> for further details.

- Creating the *.netrc* file at the user machine *Home* directory and
storing the user
[NASA](https://www.nasa.gov/ "The National Aeronautics and Space Administration")
[GES DISC](https://disc.gsfc.nasa.gov/) logging information in it is
needed to execute the *NASAaccess* package commands. Accessing data
from NASA servers is further explained at
done automatically to execute the *NASAaccess* package commands.
Accessing data from NASA servers is further explained at
[Here](https://wiki.earthdata.nasa.gov/display/EL/How+To+Access+Data+With+cURL+And+Wget).
The [GES DISC](https://disc.gsfc.nasa.gov/) user registration access
logging information will be processed by masking in the terminal on
any major OS. Without providing [GES
DISC](https://disc.gsfc.nasa.gov/) user registration access logging
information, the user will receive ‘*You need to provide your
Earthdata GES DISC login to proceed…*’ message.

- To install *NASAaccess* package in a conda environment run the
following:
Expand Down Expand Up @@ -148,7 +162,7 @@ citation(package = 'NASAaccess')
#> To cite package 'NASAaccess' in publications use:
#>
#> Mohammed I (2023). _NASAaccess: Downloading and Reformatting Tool for
#> NASA Earth Observation Data Products_. R package version 3.3.1,
#> NASA Earth Observation Data Products_. R package version 3.4.2,
#> <https://github.com/nasa/NASAaccess>.
#>
#> A BibTeX entry for LaTeX users is
Expand All @@ -159,7 +173,7 @@ citation(package = 'NASAaccess')
#> year = {2023},
#> institution = {National Aeronautics and Space Administration, Goddard Space Flight Center},
#> address = {Greenbelt, Maryland},
#> note = {R package version 3.3.1},
#> note = {R package version 3.4.2},
#> url = {https://github.com/nasa/NASAaccess},
#> }
```
2 changes: 1 addition & 1 deletion docs/404.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/LICENSE-text.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 8 additions & 8 deletions docs/articles/About.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

28 changes: 14 additions & 14 deletions docs/articles/GLDAS.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file modified docs/articles/GLDAS_files/figure-html/unnamed-chunk-4-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/articles/GLDAS_files/figure-html/unnamed-chunk-7-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 744a098

Please sign in to comment.