Skip to content

Commit

Permalink
Clean up installation section of README
Browse files Browse the repository at this point in the history
Solves #40 by moving Docker section under "Installation"

Solves #36 by removing rhdf5 installation instructions (no longer necessary)
  • Loading branch information
mbjoseph committed Jul 27, 2018
1 parent ca07839 commit 4e6b426
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 31 deletions.
31 changes: 12 additions & 19 deletions README.Rmd
Expand Up @@ -25,14 +25,6 @@ An R package for acquisition and processing of [NASA (Soil Moisture Active-Passi

## Installation

### Dependencies

To install smapr, you'll need to install the R package
[rhdf5](https://www.bioconductor.org/packages/release/bioc/html/rhdf5.html),
a Bioconductor package that will not be installed automatically when installing
smapr.
For rhdf5 installation instructions see http://bioconductor.org/packages/release/bioc/html/rhdf5.html

To install smapr from CRAN:

```{r cran-installation, eval = FALSE}
Expand All @@ -46,6 +38,18 @@ To install the development version from GitHub:
devtools::install_github("earthlab/smapr")
```

#### Docker instructions (alternative to a local installation)

If a local installation is not possible for some reason, we have made a Docker
image available with smapr and all its dependencies.

```
docker run -d -p 8787:8787 earthlab/smapr
```

In a web browser, navigate to localhost:8787 and log in with
username: rstudio, password: rstudio.


## Authentication

Expand Down Expand Up @@ -182,17 +186,6 @@ writeRaster(sm_raster, "wgs84_ft.tif")
file.remove("wgs84_ft.tif")
```

### Running smapr in Docker

To avoid dependency heck, we have made a Docker image available with smapr
and all its dependencies.

```
docker run -d -p 8787:8787 earthlab/smapr
```

In a web browser, navigate to localhost:8787 and log in with
username: rstudio, password: rstudio.

## Meta

Expand Down
20 changes: 8 additions & 12 deletions README.md
Expand Up @@ -8,10 +8,6 @@ An R package for acquisition and processing of [NASA (Soil Moisture Active-Passi
Installation
------------

### Dependencies

To install smapr, you'll need to install the R package [rhdf5](https://www.bioconductor.org/packages/release/bioc/html/rhdf5.html), a Bioconductor package that will not be installed automatically when installing smapr. For rhdf5 installation instructions see <http://bioconductor.org/packages/release/bioc/html/rhdf5.html>

To install smapr from CRAN:

``` r
Expand All @@ -25,6 +21,14 @@ To install the development version from GitHub:
devtools::install_github("earthlab/smapr")
```

#### Docker instructions (alternative to a local installation)

If a local installation is not possible for some reason, we have made a Docker image available with smapr and all its dependencies.

docker run -d -p 8787:8787 earthlab/smapr

In a web browser, navigate to localhost:8787 and log in with username: rstudio, password: rstudio.

Authentication
--------------

Expand Down Expand Up @@ -129,14 +133,6 @@ The raster stack can be saved as a GeoTIFF using the `writeRaster` function from
writeRaster(sm_raster, "wgs84_ft.tif")
```

### Running smapr in Docker

To avoid dependency heck, we have made a Docker image available with smapr and all its dependencies.

docker run -d -p 8787:8787 earthlab/smapr

In a web browser, navigate to localhost:8787 and log in with username: rstudio, password: rstudio.

Meta
----

Expand Down

0 comments on commit 4e6b426

Please sign in to comment.