https://github.com/mlampros/planetnicfi
Processing of the 'Planet NICFI' Satellite Imagery
https://github.com/mlampros/planetnicfi
aria2c gdal nicfi planet r satellite-imagery
Last synced: about 1 year ago
JSON representation
Processing of the 'Planet NICFI' Satellite Imagery
- Host: GitHub
- URL: https://github.com/mlampros/planetnicfi
- Owner: mlampros
- Created: 2021-06-12T11:04:45.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-04T04:39:24.000Z (over 2 years ago)
- Last Synced: 2024-04-23T11:17:37.219Z (about 2 years ago)
- Topics: aria2c, gdal, nicfi, planet, r, satellite-imagery
- Language: R
- Homepage: https://mlampros.github.io/PlanetNICFI/
- Size: 3.59 MB
- Stars: 5
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://github.com/mlampros/PlanetNICFI/actions)
[](https://codecov.io/github/mlampros/PlanetNICFI?branch=master)
[](https://CRAN.R-project.org/package=PlanetNICFI)
[](http://www.r-pkg.org/pkg/PlanetNICFI)
[](https://hub.docker.com/r/mlampros/planetnicfi)
[](https://cran.r-project.org/package=PlanetNICFI)
## PlanetNICFI
The **PlanetNICFI** R package includes functions to download and process the [NICFI](https://www.nicfi.no/) (**Norway's International Climate and Forest Initiative**) Planet Satellite Imagery utilizing the [Planet Mosaics API](https://developers.planet.com/docs/basemaps/reference/#tag/Basemaps-and-Mosaics). More details on the functionality of PlanetNICFI can be found in the [blog-post](http://mlampros.github.io/2021/06/12/Planet_NICFI_Satellite_Imagery/), Vignette and in the package Documentation ( *scroll down for information on how to use the* **docker image** )
#### **Parameters**:
An **important parameter** to keep in mind is the **page_size** of the [nicfi_quads_bbox()](https://mlampros.github.io/PlanetNICFI/reference/nicfi_quads_bbox.html) function. Depending on what the user defines as **bbox_AOI** or **wkt_AOI** the **page_size** parameter needs to be adjusted too. The bigger the Area of Interest is the bigger the **page_size** parameter must be. That means the [nicfi_quads_bbox()](https://mlampros.github.io/PlanetNICFI/reference/nicfi_quads_bbox.html) function will return more Image products for a bigger area and the **page_size** parameter **must** be bigger than the **default** value of **50** so that all available Image products will be returned.
Another **important information** to keep in mind (if using the *'aria2c'* software to download the data - see the *'sequential_download_paths()'* function for an alternative) is that the user currently **has to download** the NICFI .tif files in a **temporary directory** due to the **aria2c_download_paths()** function. By specifying a different **default_directory** parameter other than a temporary directory in the **aria2c_bulk_donwload()** function the .tif files won't be downloaded in the correct folder.
#### **System Requirements**:
##### **GDAL**
The usage of the *PlanetNICFI* package requires a geospatial setup as specified in the [sf](https://github.com/r-spatial/sf#installing) or [terra](https://github.com/rspatial/terra#from-source-code) README.md files.
##### **aria2c**
Besides the *'sequential_download_paths()'* function the [aria2c](https://aria2.github.io/) software is another option to download the data in parallel. It has to be installed first in the Operating System:
On **Ubuntu** this can be done using:
```R
sudo apt-get install aria2
```
On **Macintosh** use,
```R
brew install aria2
```
and on **Windows 10** based on a [web-tutorial](https://www.tutorialexample.com/install-aria2-on-win10-to-download-files-a-beginner-guide/):
* first navigate to the [Github repository of aria2c](https://github.com/aria2/aria2/releases/tag/release-1.35.0)
* then download the **aria2-1.35.0-win-64bit-build1.zip** (where **1.35.0** corresponds to the current version as of **June 2021** - this might change in the future)
* unzip the downloaded file
* create a folder named as **aria2** in **C:\\**
* copy the **aria2c.exe** file to **C:\\aria2**
* add the **C:\\aria2** to the windows system path by updating the environment variables
* finally open the window command prompt, enter **aria2c** and the output message should show the aria2c options
To install the package from CRAN use,
```R
install.packages("PlanetNICFI")
```
and to download the latest version of the package from Github,
```R
remotes::install_github('mlampros/PlanetNICFI')
```
#### **Tropical Forests Satellite Data Coverage**
#### **Docker Image** (if you want to avoid the installation of the System Requirements)
**Docker images** of the *PlanetNICFI* package are available to download from my [dockerhub](https://hub.docker.com/r/mlampros/planetnicfi) account. The images come with *Rstudio* and the *R-development* version (latest) installed. The whole process was tested on Ubuntu 18.04. To **pull** & **run** the image do the following,
```R
docker pull mlampros/planetnicfi:rstudiodev
docker run -d --name rstudio_dev -e USER=rstudio -e PASSWORD=give_here_your_password --rm -p 8787:8787 mlampros/planetnicfi:rstudiodev
```
The user can also **bind** a home directory / folder to the image to use its files by specifying the **-v** command,
```R
docker run -d --name rstudio_dev -e USER=rstudio -e PASSWORD=give_here_your_password --rm -p 8787:8787 -v /home/YOUR_DIR:/home/rstudio/YOUR_DIR mlampros/planetnicfi:rstudiodev
```
In the latter case you might have first give permission privileges for write access to **YOUR_DIR** directory (not necessarily) using,
```R
chmod -R 777 /home/YOUR_DIR
```
The **USER** defaults to *rstudio* but you have to give your **PASSWORD** of preference (see [https://rocker-project.org/](https://rocker-project.org/) for more information).
Open your web-browser and depending where the docker image was *build / run* give,
**1st. Option** on your personal computer,
```R
http://0.0.0.0:8787
```
**2nd. Option** on a cloud instance,
```R
http://Public DNS:8787
```
to access the Rstudio console in order to give your username and password.
### NICFI Satellite Data Program user community code repositories
* https://github.com/NICFI-Satellite-Data-Program/Code-Repository
### Attribution
Please read the **COPYRIGHTS** file of the **PlanetNICFI** R package especially the section **'OBLIGATIONS AND RESTRICTIONS'**
### Citation:
If you use the **PlanetNICFI** R package in your paper or research please cite:
```R
@Manual{,
title = {{PlanetNICFI}: Processing of the 'Planet NICFI' Satellite Imagery using R},
author = {Lampros Mouselimis},
year = {2023},
note = {R package version 1.0.5 using Imagery 2021 Planet Labs Inc. All use subject to the Participant License Agreement},
url = {https://CRAN.R-project.org/package=PlanetNICFI},
}
```