NEWS.md

In ideas-lab-nus/epwshiftr: Create Future 'EnergyPlus' Weather Files using 'CMIP6' Data

eplusr (development version)

Bug fixes

• future_epw() now correctly handles missing values when generating future weather files.

epwshiftr 0.1.4

Major changes

• match_coord() has been refactored to correct the calculation method of geographical distance. Previously, epwshiftr assumes that distance on longitude and latitude is the same which is not true. Now it uses a spheroid formula to calculate the tunnel distance (#39). For details, please see Tunnel Distance . The structure of the returned epw_cmip6_coord object has also changed. The coord column in the coord data.table is also a data.table which contains 6 columns describing the matched coordinates:
• index: the indices of matched coordinates
• ind_lon, ind_lat: The value indices of longitude or latitude in the NetCDF coordinate grids. These values are used to extract the corresponding variable values
• lon, lat: the actual longitude or latitude in the NetCDF coordinate grids
• dist: the distance in km between the coordinate values in NetCDF and input EPW

Besides, the usage of the input threshold and max_num has been changed a little bit:

• threshold: Due to the change in distance calculation, the meaning of the threshold input has been changed. Instead of directly being used to get the 'closest' grid points in NetCDF, the longitude and latitude threshold is only used to help exclude grid points that are definitely too far away from the target location. The default threshold, which is 1 degree for both longitude and latitude, is still reasonable for common use cases and is kept unchanged. Also threshold now can be set to NULL. In this case, the distances between the target location and all grid points will be calculated. But this may be only useful for rare cases.
• max_num: Now the value max_num is the key input to control how many grid points are to be matched. The points will always be ordered in descending order in terms of the distances.
• The data in the returned value of extract_data() has been updated to include a new column dist which gives the spherical distance in km between EPW location and grid coordinates (#39).
• The document on the return value structure for extract_data() and morphing_epw() has been fixed (#29). And the column order for all metadata in the returned data.table from extract_data() and morphing_epw() are not consistent. The columns will always be in the order below (#45):
• activity_drs
• institution_id
• source_id
• experiment_id
• member_id
• table_id
• lon
• lat
• dist

New features

• A new parameter full is added to future_epw(). When setting to TRUE, a data.table containing information about how the data are split by the by argument and also the generated future EPWs and their paths are returned (#18).
• Now summary_database() can append results to the previous scan and detect if any previously matched NetCDF files do not exist. It stores the metadata of those missing files as a new attribute not_found in the results. Warnings are issued if warning is set to TRUE. Also, a new parameter miss has been added to control how to manage those invalid entries. You can set it to "keep", which is the default, to do nothing about it or "overwrite" to overwrite those entries based on the newly matched NetCDF files if possible (#40).
• extract_data() now supports non-standard calendar, e.g. 360_day (#32).
• A new parameter warning has been added in morphing_epw(). If set to TRUE, warnings will be issued for cases with input data less than a decade (10 years) . This is because using data that only covers a short period of time may not be able to capture the average of future climate (#41).
• Now epwshiftr is able to download, parse and store CMIP6 Controlled Vocabularies (CVs) and Data Request data using the newly introduced class Cmip6Dict. Please see ?Cmip6Dict for details (#53).
• A new option epwshiftr.threshold_alpha has been added to set the threshold of the absolute value for alpha, i.e. monthly-mean fractional change when performing morphing operations. The default value is set to 3. If the morphing methods are set "stretch" or "combined", and the absolute alpha exceeds the threshold value, warnings are issued and the morphing method is fallbacked to "shift" to avoid unrealistic morphed values (#54).
• Now HDF5 format is supported (#60).
• Now replica can be NULL in esgf_query() and init_cmip6_index(). In this case, both the master record and replicas are all returned (#61).
• New class EsgfQuery is added to support more flexible APIs for ESGF search services. Please see ?EsgfQuery for details (#63, #69).

Bug fixes

• Fix the error in summary_database() when no NetCDF files are found in the input directory (#25).
• Fix the error about overwriting temporary EPW file when epw in match_coord() is a search string (#25).
• Now morphing_epw() can correctly fall back to use "Shift" method when any missing values are detected in maximum and minimum prediction values of climate variables (#25).
• Fix the wrong warning messages when combined method is used in morphing_epw() (#25).
• Now get_data_node() works again (#80)

Internal refactor

• fields parameter is used to directly filter the ESGF query responses (#66).
• Improve URL encoding (#62).
• Update minimal version of depended packages (#75).

epwshiftr 0.1.3

Minor changes

• Remove LazyData in DESCRIPTION (#16).

epwshiftr 0.1.2

New features

• The type of morphing methods can be specified using the newly added methods argument in morphing_epw().

Bug fixes

• esgf_query() can accept NULL resolution argument (#12).
• load_cimp6_index() can be correctly load local CMIP6 output index file when force is TRUE (#8).

epwshiftr 0.1.1

Bug fixes

• esgf_query() will give an informative message when LLNL ESGF node is not available (#3).
• extract_data() will automatically detect input NetCDF dimensions (#6).
• summary_database() now will proceed when no matched found (#6).

epwshiftr 0.1.0

• Initial CRAN version

ideas-lab-nus/epwshiftr documentation built on May 21, 2024, 12:31 a.m.