{"id":23415328,"url":"https://github.com/mlampros/planetnicfi","last_synced_at":"2025-04-12T07:34:33.852Z","repository":{"id":56934127,"uuid":"376268892","full_name":"mlampros/PlanetNICFI","owner":"mlampros","description":"Processing of the 'Planet NICFI' Satellite Imagery","archived":false,"fork":false,"pushed_at":"2023-12-04T04:39:24.000Z","size":3766,"stargazers_count":5,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-23T11:17:37.219Z","etag":null,"topics":["aria2c","gdal","nicfi","planet","r","satellite-imagery"],"latest_commit_sha":null,"homepage":"https://mlampros.github.io/PlanetNICFI/","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mlampros.png","metadata":{"funding":{"github":["mlampros"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null},"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2021-06-12T11:04:45.000Z","updated_at":"2023-12-25T14:02:04.000Z","dependencies_parsed_at":"2023-12-18T03:44:22.506Z","dependency_job_id":null,"html_url":"https://github.com/mlampros/PlanetNICFI","commit_stats":{"total_commits":25,"total_committers":1,"mean_commits":25.0,"dds":0.0,"last_synced_commit":"ee71ff0e0a4f9abfa1ac363daad0c11fc31a463a"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mlampros%2FPlanetNICFI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mlampros%2FPlanetNICFI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mlampros%2FPlanetNICFI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mlampros%2FPlanetNICFI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mlampros","download_url":"https://codeload.github.com/mlampros/PlanetNICFI/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248534764,"owners_count":21120422,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aria2c","gdal","nicfi","planet","r","satellite-imagery"],"created_at":"2024-12-22T21:14:44.545Z","updated_at":"2025-04-12T07:34:33.759Z","avatar_url":"https://github.com/mlampros.png","language":"R","funding_links":["https://github.com/sponsors/mlampros","https://www.buymeacoffee.com/VY0x8snyh"],"categories":[],"sub_categories":[],"readme":"\n[![tic](https://github.com/mlampros/PlanetNICFI/workflows/tic/badge.svg?branch=master)](https://github.com/mlampros/PlanetNICFI/actions)\n[![codecov.io](https://codecov.io/github/mlampros/PlanetNICFI/coverage.svg?branch=master)](https://codecov.io/github/mlampros/PlanetNICFI?branch=master)\n[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/PlanetNICFI)](https://CRAN.R-project.org/package=PlanetNICFI)\n[![Downloads](http://cranlogs.r-pkg.org/badges/grand-total/PlanetNICFI?color=blue)](http://www.r-pkg.org/pkg/PlanetNICFI)\n\u003ca href=\"https://www.buymeacoffee.com/VY0x8snyh\" target=\"_blank\"\u003e\u003cimg src=\"https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png\" alt=\"Buy Me A Coffee\" height=\"21px\" \u003e\u003c/a\u003e\n[![](https://img.shields.io/docker/automated/mlampros/planetnicfi.svg)](https://hub.docker.com/r/mlampros/planetnicfi)\n[![Dependencies](https://tinyverse.netlify.com/badge/PlanetNICFI)](https://cran.r-project.org/package=PlanetNICFI)\n\n\n## PlanetNICFI\n\n\u003cbr\u003e\n\nThe **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** )\n\n\u003cbr\u003e\n\n#### **Parameters**:\n\n\u003cbr\u003e\n\nAn **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.\n\n\u003cbr\u003e\n\nAnother **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.\n\n\u003cbr\u003e\n\n#### **System Requirements**:\n\n\u003cbr\u003e\n\n##### **GDAL**\n\nThe 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.\n\n\u003cbr\u003e\n\n##### **aria2c**\n\nBesides 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:\n\nOn **Ubuntu** this can be done using:\n\n```R\nsudo apt-get install aria2\n\n```\n\n\u003cbr\u003e\n\nOn **Macintosh** use,\n\n```R\nbrew install aria2\n\n```\n\n\u003cbr\u003e\n\nand on **Windows 10** based on a [web-tutorial](https://www.tutorialexample.com/install-aria2-on-win10-to-download-files-a-beginner-guide/):\n\n* first navigate to the [Github repository of aria2c](https://github.com/aria2/aria2/releases/tag/release-1.35.0)\n* 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)\n* unzip the downloaded file \n* create a folder named as **aria2** in **C:\\\\**\n* copy the **aria2c.exe** file to **C:\\\\aria2**\n* add the **C:\\\\aria2** to the windows system path by updating the environment variables\n* finally open the window command prompt, enter **aria2c** and the output message should show the aria2c options\n\n\u003cbr\u003e\n\nTo install the package from CRAN use, \n\n```R\ninstall.packages(\"PlanetNICFI\")\n\n```\n\u003cbr\u003e\n\nand to download the latest version of the package from Github,\n\n```R\nremotes::install_github('mlampros/PlanetNICFI')\n\n```\n\n\u003cbr\u003e\u003cbr\u003e\n\n#### **Tropical Forests Satellite Data Coverage**\n\n\u003cbr\u003e\n\n\u003cimg src=\"man/figures/nicfi_tropical_forests.png\" \u003e\u003c/img\u003e\n\n\u003cbr\u003e\n\n#### **Docker Image** (if you want to avoid the installation of the System Requirements)\n\n\u003cbr\u003e\n\n**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** \u0026 **run** the image do the following,\n\n\u003cbr\u003e\n\n```R\n\ndocker pull mlampros/planetnicfi:rstudiodev\n\ndocker run -d --name rstudio_dev -e USER=rstudio -e PASSWORD=give_here_your_password --rm -p 8787:8787 mlampros/planetnicfi:rstudiodev\n\n```\n\n\u003cbr\u003e\n\nThe user can also **bind** a home directory / folder to the image to use its files by specifying the **-v** command,\n\n\u003cbr\u003e\n\n```R\n\ndocker 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\n\n\n```\n\n\u003cbr\u003e\n\nIn the latter case you might have first give permission privileges for write access to **YOUR_DIR** directory (not necessarily) using,\n\n\u003cbr\u003e\n\n```R\n\nchmod -R 777 /home/YOUR_DIR\n\n\n```\n\n\u003cbr\u003e\n\nThe **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).\n\n\u003cbr\u003e\n\nOpen your web-browser and depending where the docker image was *build / run* give, \n\n\u003cbr\u003e\n\n**1st. Option** on your personal computer,\n\n\u003cbr\u003e\n\n```R\nhttp://0.0.0.0:8787 \n\n```\n\n\u003cbr\u003e\n\n**2nd. Option** on a cloud instance, \n\n\u003cbr\u003e\n\n```R\nhttp://Public DNS:8787\n\n```\n\n\u003cbr\u003e\n\nto access the Rstudio console in order to give your username and password.\n\n\u003cbr\u003e\n\n### NICFI Satellite Data Program user community code repositories\n\n* https://github.com/NICFI-Satellite-Data-Program/Code-Repository\n\n\u003cbr\u003e\n\n### Attribution\n\nPlease read the **COPYRIGHTS** file of the **PlanetNICFI** R package especially the section **'OBLIGATIONS AND RESTRICTIONS'**\n\n\u003cbr\u003e\n\n### Citation:\n\nIf you use the **PlanetNICFI** R package in your paper or research please cite:\n\n\u003cbr\u003e\n\n```R\n@Manual{,\n  title = {{PlanetNICFI}: Processing of the 'Planet NICFI' Satellite Imagery using R},\n  author = {Lampros Mouselimis},\n  year = {2023},\n  note = {R package version 1.0.5 using Imagery 2021 Planet Labs Inc. All use subject to the Participant License Agreement},\n  url = {https://CRAN.R-project.org/package=PlanetNICFI},\n}\n```\n\n\u003cbr\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmlampros%2Fplanetnicfi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmlampros%2Fplanetnicfi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmlampros%2Fplanetnicfi/lists"}