Repository files navigation

ThePlanetNICFI R package includes functions to download and process theNICFI (Norway's International Climate and Forest Initiative) Planet Satellite Imagery utilizing thePlanet Mosaics API. More details on the functionality of PlanetNICFI can be found in theblog-post, Vignette and in the package Documentation (scroll down for information on how to use thedocker image )

Animportant parameter to keep in mind is thepage_size of thenicfi_quads_bbox() function. Depending on what the user defines asbbox_AOI orwkt_AOI thepage_size parameter needs to be adjusted too. The bigger the Area of Interest is the bigger thepage_size parameter must be. That means thenicfi_quads_bbox() function will return more Image products for a bigger area and thepage_size parametermust be bigger than thedefault value of50 so that all available Image products will be returned.

Anotherimportant 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 currentlyhas to download the NICFI .tif files in atemporary directory due to thearia2c_download_paths() function. By specifying a differentdefault_directory parameter other than a temporary directory in thearia2c_bulk_donwload() function the .tif files won't be downloaded in the correct folder.

The usage of thePlanetNICFI package requires a geospatial setup as specified in thesf orterra README.md files.

Besides the'sequential_download_paths()' function thearia2c software is another option to download the data in parallel. It has to be installed first in the Operating System:

OnUbuntu this can be done using:

sudoapt-getinstallaria2

OnMacintosh use,

brewinstallaria2

and onWindows 10 based on aweb-tutorial:

• first navigate to theGithub repository of aria2c
• then download thearia2-1.35.0-win-64bit-build1.zip (where1.35.0 corresponds to the current version as ofJune 2021 - this might change in the future)
• unzip the downloaded file
• create a folder named asaria2 inC:\
• copy thearia2c.exe file toC:\aria2
• add theC:\aria2 to the windows system path by updating the environment variables
• finally open the window command prompt, enteraria2c and the output message should show the aria2c options

To install the package from CRAN use,

install.packages("PlanetNICFI")

and to download the latest version of the package from Github,

remotes::install_github('mlampros/PlanetNICFI')

Docker images of thePlanetNICFI package are available to download from mydockerhub account. The images come withRstudio and theR-development version (latest) installed. The whole process was tested on Ubuntu 18.04. Topull &run the image do the following,

dockerpullmlampros/planetnicfi:rstudiodevdockerrun-d--namerstudio_dev-eUSER=rstudio-ePASSWORD=give_here_your_password--rm-p8787:8787mlampros/planetnicfi:rstudiodev

The user can alsobind a home directory / folder to the image to use its files by specifying the-v command,

dockerrun-d--namerstudio_dev-eUSER=rstudio-ePASSWORD=give_here_your_password--rm-p8787:8787-v/home/YOUR_DIR:/home/rstudio/YOUR_DIRmlampros/planetnicfi:rstudiodev

In the latter case you might have first give permission privileges for write access toYOUR_DIR directory (not necessarily) using,

chmod-R777/home/YOUR_DIR

TheUSER defaults torstudio but you have to give yourPASSWORD of preference (seehttps://rocker-project.org/ for more information).

Open your web-browser and depending where the docker image wasbuild / run give,

1st. Option on your personal computer,

http://0.0.0.0:8787

2nd. Option on a cloud instance,

http://PublicDNS:8787

to access the Rstudio console in order to give your username and password.

• https://github.com/NICFI-Satellite-Data-Program/Code-Repository

Please read theCOPYRIGHTS file of thePlanetNICFI R package especially the section'OBLIGATIONS AND RESTRICTIONS'

If you use thePlanetNICFI R package in your paper or research please cite:

@Manual{,title= {{PlanetNICFI}:Processingofthe'Planet NICFI'SatelliteImageryusingR},author= {LamprosMouselimis},year= {2023},note= {Rpackageversion1.0.5usingImagery2021PlanetLabsInc.AllusesubjecttotheParticipantLicenseAgreement},url= {https://CRAN.R-project.org/package=PlanetNICFI},}