ecmwf / caliver Goto Github PK

View Code? Open in Web Editor NEW

18.0 5.0 8.0 9 MB

caliver: CALIbration and VERification of gridded fire danger models

Home Page: https://ecmwf.github.io/caliver

R 99.27% Dockerfile 0.73%

natural-hazard geospatial-data verification calibration netcdf r wildfire

caliver's Introduction

caliver

An R package for the calibration and verification of gridded models

caliver is a package developed for the R programming language. The name stands for calIbration and verification of gridded models. Although caliver was initially designed for wildfire danger models such as GEFF (developed by ECMWF) and RISICO (developed by CIMA Research Foundation), the algorithms can be applied to any gridded model output. Caliver is available with an APACHE-2 license.

For more details, please see the following papers:

Vitolo C, Di Giuseppe F, D’Andrea M (2018) Caliver: An R package for CALIbration and VERification of forest fire gridded model outputs. PLOS ONE 13(1): e0189419. https://doi.org/10.1371/journal.pone.0189419 Please note: in the latest version of the caliver package many functionalities described in this paper have become obsolete and deprecated, please refer to the vignette "An introduction to the caliver package" for more details.
Vitolo C., Di Giuseppe F., Barnard C., Coughlan R., Krzeminski B., San-Miguel-Ayanz J. ERA5-based global meteorological wildfire danger maps. Sci Data 7, 216 (2020). https://doi.org/10.1038/s41597-020-0554-z
Vitolo C., Di Giuseppe F., Krzeminski B., San-Miguel-Ayanz J. A 1980–2018 global fire danger re-analysis dataset for the Canadian Fire Weather Indices, Sci Data 6, 190032 (2019). https://doi.org/10.1038/sdata.2019.32

Installation

The installation of the caliver package depends on the following libraries:

Geospatial Data Abstraction Library (GDAL)
NetCDF4 (netcdf4)

Make sure you have the above libraries installed before attempting to install caliver. Once all the dependencies are installed, get caliver's development version from github using devtools:

install.packages("remotes")
remotes::install_github("ecmwf/caliver")

Alternatively, the stable version of this package is available on CRAN and can be installed as shown below.

install.packages("caliver")

Load the package:

library("caliver")

Docker

In this repository you find a Dockerfile that contains all the necessary dependencies and the caliver package already installed.

docker build -t ecmwf/caliver:latest -f Dockerfile .

Alternatively, you can use the image we host on docker hub:

docker run -it --rm ecmwf/caliver:latest bash

caliver's People

Contributors

Stargazers

Watchers

Forkers

fannieno lteckentrup karagul hugoaluque carletes jhouwang isabella232 schuch666

caliver's Issues

Tests for mask_crop_subset() generate warning/error

Tests for mask_crop_subset() generate the following warning/error:

attempt to apply non-function

According to the annotations in GH actions, this only happens in ubuntu and windows os.

Tests for get_perc_risk_index() are also affected as the function calls mask_crop_subset().

Build of docker image is failing

Build of docker image is failing: https://hub.docker.com/repository/docker/ecmwf/caliver
@carletes @StephanSiemen any idea?

can't modify default fire season

Hi,

I have a question regarding the get_fire_season function. I just realized that adjusting the fire season, e. g. to a shorter period, does not return the shorter period. Instead the dataset is subsetted to the default fire season from April to October. Is this a mistake from my side or a bug?

cheers!
Julia

> #open file
> kfc <- brick("D:/RProjects/fwi/01_fastdata/KFC/fwi_KFC_1981010100_to_2010123100.nc")
> names(kfc) <- seq.Date(from = as.Date("1981-01-01"),
>                      to = as.Date("2010-12-31"),
>                      by = "day")
> dataDates <- as.Date(substr(names(kfc), 2, 11), format = "%Y.%m.%d") #create dates from layer name
> seasons <- get_fire_season(dates = dataDates,
>                            fss = as.Date("2012-04-01", format = "%Y-%m-%d"),
>                            fse = as.Date("2012-09-30", format = "%Y-%m-%d"),
>                            zone='north') #returns true false layer
> kfc_season <- kfc[[which(seasons==TRUE)]]
> seasonDates <- dataDates[which(seasons==TRUE)]

Update vignettes

Since the publication of the caliver paper on PlosONE (https://journals.plos.org/plosone/article/related?id=10.1371/journal.pone.0189419) some functionalities have changed or have been deprecated. The vignettes need to be updated to document the changes.

CRAN submission

Caliver is not yet on CRAN, a submission needs to be prepared.

New GEFF data - file structure changed, utility functions become obsolete

With GEFF v2.2, the file structure and naming convention have changed.
Caliver utility functions used to handle previous naming convention are now obsolete and will need to be removed.

Migrate CI

Travis-ci.org is shutting down. Will need to migrate CI from Travis to GitHub actions.

Data for 2019 or years going forward?

Hi all,

caliver is a wonderful package! It is proving extremely helpful for some projects.

I was wondering - is there any intent of the authors to provide 2019, 2020, or ongoing data? Or is caliver specifically for the original 1980–2018 study period?

Thank you so much!

MonthlyBurnedAreas <- get_gfed4(start_date = "2003-01-01",  
                                end_date = "2003-01-31",
                                temporal_resolution = "monthly", 
                                varname = "BurnedArea")

If I try the same code in the terminal, everything works OK!