Skip to content

Commit

Permalink
Add missing PR's to whats-new (#1727)
Browse files Browse the repository at this point in the history
* add PR numbers of merge_gridded_data in whats-new

* added several entries in whats-new

* complete

---------

Co-authored-by: Fabien Maussion <[email protected]>
  • Loading branch information
pat-schmitt and fmaussion authored Aug 24, 2024
1 parent 00552b6 commit 11e64ed
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 6 deletions.
14 changes: 12 additions & 2 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,12 @@ the majority of OGGM's tasks). They are parallelizable.
tasks.glacier_masks
tasks.simple_glacier_masks
tasks.rasterio_glacier_mask
tasks.rasterio_glacier_exterior_mask
tasks.compute_hypsometry_attributes
tasks.gridded_attributes
tasks.gridded_mb_attributes
tasks.gridded_data_var_to_geotiff
tasks.rgi7g_to_complex
tasks.compute_centerlines
tasks.compute_downstream_line
tasks.compute_downstream_bedshape
Expand All @@ -145,25 +148,31 @@ the majority of OGGM's tasks). They are parallelizable.
tasks.fixed_dx_elevation_band_flowline
tasks.process_climate_data
tasks.process_custom_climate_data
tasks.historical_delta_method
tasks.mb_calibration_from_scalar_mb
tasks.mb_calibration_from_geodetic_mb
tasks.mb_calibration_from_wgms_mb
tasks.apparent_mb_from_linear_mb
tasks.apparent_mb_from_any_mb
tasks.perturbate_mb_params
tasks.fixed_geometry_mass_balance
tasks.compute_ela
tasks.process_w5e5_data
tasks.process_cru_data
tasks.process_dummy_cru_file
tasks.process_histalp_data
tasks.process_ecmwf_data
tasks.process_gcm_data
tasks.process_cesm_data
tasks.process_monthly_isimip_data
tasks.process_cmip_data
tasks.historical_delta_method
tasks.process_lmr_data
tasks.process_modera_data
tasks.prepare_for_inversion
tasks.mass_conservation_inversion
tasks.filter_inversion_output
tasks.get_inversion_volume
tasks.compute_velocities
tasks.compute_inversion_velocities
tasks.distribute_thickness_per_altitude
tasks.distribute_thickness_interp
Expand All @@ -173,11 +182,12 @@ the majority of OGGM's tasks). They are parallelizable.
tasks.run_random_climate
tasks.run_from_climate_data
tasks.run_constant_climate
tasks.merge_consecutive_run_outputs
tasks.run_with_hydro
tasks.run_dynamic_spinup
tasks.run_dynamic_melt_f_calibration
tasks.copy_to_basedir
tasks.gdir_to_tar
tasks.merge_consecutive_run_outputs

.. _apiglobaltasks:

Expand Down
36 changes: 35 additions & 1 deletion docs/whats-new.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ Enhancements
for merging distributed data from multiple glacier directories, including
the possibility of adding topography to the merged grid. The latter function
acts as a wrapper for the first one, specifically designed for merging
distributed thickness data from a dynamic model run.
distributed thickness data from a dynamic model run (:pull:`1674`,
:pull:`1691`, :pull:`1697` and :pull:`1719`).
By `Alex Fischer <https://github.com/afisc>`_ and
`Patrick Schmitt <https://github.com/pat-schmitt>`_
- Added a new calving module to the sandbox. The module is based on
Expand All @@ -43,10 +44,43 @@ Enhancements
By `Alex Fischer <https://github.com/afisc>`_
- Added Cook et al 2023 Alps thickness data to the shop (:pull:`1724`).
By `Fabien Maussion <https://github.com/fmaussion>`_
- Added support for RGI7 (:pull:`1657`, :pull:`1702` and :pull:`1720`).
By `Fabien Maussion <https://github.com/fmaussion>`_
- Added GlaThiDa data to the shop (:pull:`1663`).
By `Fabien Maussion <https://github.com/fmaussion>`_
- Added an installation guide for Windows users (:pull:`1666` and :pull:`1683`).
By `Anouk Vlug <https://github.com/fmaussion>`_,
`Rebekka Neugebauer <https://github.com/rebneugebauer>`_ and
`Fabien Maussion <https://github.com/fmaussion>`_
- Made it easier to run parameter perturbation experiments by
allowing more than one mb_calib.json file in the
working directory (:pull:`1678`) and by adding a new
`perturbate_mb_params` task (:pull:`1669`).
By `Fabien Maussion <https://github.com/fmaussion>`_
- Preprocessed directories can now have categorical resolution
classes like GloGEM does (did it for IGM), where users can choose
bins where a given dx is used (:pull:`1664`). It looks nicer
to the eye but I still think the continue dx approach is better.
By `Fabien Maussion <https://github.com/fmaussion>`_
- The mass-balance model can now be calibrated on regional averages
instead of glacier-per-glacier values. This is useful to trick
RGI7 into being calibrated or other things (:pull:`1692`).
By `Fabien Maussion <https://github.com/fmaussion>`_

Bug fixes
~~~~~~~~~

- Fixed a bug in ``inversion.filter_inversion_output`` that caused an error
for small glaciers with fewer than five grid points containing ice
(:pull:`1635`).
By `Patrick Schmitt <https://github.com/pat-schmitt>`_
- Changed variable name from ``t_bias`` to ``t_spinup`` in
``dynamic_spinup.run_dynamic_spinup``, to avoid confusions with
variable names of the massbalance models (:pull:`1671`).
By `Patrick Schmitt <https://github.com/pat-schmitt>`_
- Fixed a bug in ``dynamic_spinup.run_dynamic_melt_f_calibration`` that allowed
the melt_f value to slightly exceed the defined limits (:pull:`1685`).
By `Patrick Schmitt <https://github.com/pat-schmitt>`_
- The binned variables in the elevation band flowlines did not use the
glacier mask when preserving the total values. This is a bad
bug that is now fixed (:pull:`1661`).
Expand Down
4 changes: 2 additions & 2 deletions oggm/core/massbalance.py
Original file line number Diff line number Diff line change
Expand Up @@ -1504,7 +1504,7 @@ def mb_calibration_from_geodetic_mb(gdir, *,
same parameters as MonthlyTIModel (the default): melt_f,
temp_bias, prcp_fac.
filesuffix: str
add a filesuffix to mb_params.json. This could be useful for sensitivity
add a filesuffix to mb_calib.json. This could be useful for sensitivity
analyses with MB models, if they need to fetch other sets of params for
example.
Expand Down Expand Up @@ -1729,7 +1729,7 @@ def mb_calibration_from_scalar_mb(gdir, *,
the maximum accepted value for the temperature bias during optimisation.
Defaults to cfg.PARAMS['temp_bias_max'].
filesuffix: str
add a filesuffix to mb_params.json. This could be useful for sensitivity
add a filesuffix to mb_calib.json. This could be useful for sensitivity
analyses with MB models, if they need to fetch other sets of params for
example.
"""
Expand Down
1 change: 0 additions & 1 deletion oggm/global_tasks.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
from oggm.workflow import inversion_tasks
from oggm.workflow import calibrate_inversion_from_consensus
from oggm.workflow import merge_glacier_tasks

from oggm.utils import get_ref_mb_glaciers
from oggm.utils import write_centerlines_to_shape
from oggm.utils import compile_run_output
Expand Down

0 comments on commit 11e64ed

Please sign in to comment.