Skip to content

Commit

Permalink
Release v1.6.2
Browse files Browse the repository at this point in the history
  • Loading branch information
fmaussion committed Aug 25, 2024
1 parent 07c1ead commit 41162d9
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 10 deletions.
6 changes: 3 additions & 3 deletions HOWTO_RELEASE
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ How to issue an OGGM release.
git pull
2. Look over whats-new.rst and the docs. Make sure "What's New" is complete
(check the date!) and add a brief summary note describing the release at the
top.
top. Check index.rst to update the version here as well.
3. If you have any doubts, run the full test suite one final time!
pytest --run-slow --mpl .
4. On the master branch, commit the release in git:
Expand All @@ -14,7 +14,7 @@ How to issue an OGGM release.
git tag -a v1.X.Y -m 'v1.X.Y'
6. Build source and binary wheels for pypi:
git clean -xdf # this deletes all uncommitted changes!
python setup.py bdist_wheel sdist
python -m build
7. Use twine to register and upload the release on pypi. Be careful, you can't
take this back!
twine upload dist/oggm-1.X.Y*
Expand Down Expand Up @@ -44,6 +44,6 @@ How to issue an OGGM release.
It should now build automatically.
14. Now the containers: run CI on https://github.com/OGGM/r2d to get the correct
on https://github.com/OGGM/r2d/pkgs/container/r2d. Then update the tag on
https://github.com/OGGM/binder, in the master and stable branch.
https://github.com/OGGM/binder, in the master and stable branch.
On https://hub.oggm.org, create a new environment as well.
15. Issue the release announcement!
9 changes: 6 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,12 @@ OGGM is above all a modular platform that supports novel modelling workflows,
Our framework is designed to be flexible and adaptable, making it an
ideal tool for a wide range of applications in glaciology and related fields.

**This webpage is for the software documentation**: for general information about the
OGGM project and related news, visit `oggm.org <http://oggm.org>`_. For
the educational platform, visit `edu.oggm.org <http://edu.oggm.org>`_ .
**This webpage is for the software documentation for version 1.6.2**:

- check-out :doc:`whats-new` to read about the updates in this version
- visit `oggm.org <http://oggm.org>`_ for general news
- visit `tutorials.oggm.org <http://tutorials.oggm.org>`_ for the interactive tutorials
- visit `edu.oggm.org <http://edu.oggm.org>`_ for the educational platform

.. admonition:: A note for new users

Expand Down
7 changes: 4 additions & 3 deletions docs/whats-new.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
Version history
===============

v1.6.2 (unreleased)
-------------------
v1.6.2 (August 25, 2024)
------------------------

A new minor release of the OGGM with several improvements and bug fixes.
The changes and additions are important, but not fundamental.
Expand All @@ -14,7 +14,8 @@ directories are still compatible and can be used with this version.
Some bugs have been fixed however (see below), and if they matter to you,
you may have to reprocess the data yourself or be patient (we aim to
publish a "final" 1.6.X release before the end of the year, which will comprise
updated processed datasets, including a working version of RGI7 repositories).
updated preprocessed repositories, including a working version of RGI7
repositories).

Enhancements
~~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion oggm/core/inversion.py
Original file line number Diff line number Diff line change
Expand Up @@ -631,7 +631,7 @@ def get_inversion_volume(gdir):

@entity_task(log, writes=['inversion_output'])
def compute_velocities(*args, **kwargs):
"""Deprecated. Use compute_inversion_velocities instead."""
"""Deprecated - use compute_inversion_velocities instead."""
warnings.warn("`compute_velocities` has been renamed to "
"`compute_inversion_velocities`. Prefer to use the new"
"name from now on.")
Expand Down

0 comments on commit 41162d9

Please sign in to comment.