From 239339f859bfbc4c9c946c85792eacbf8895a11f Mon Sep 17 00:00:00 2001 From: Oliver Sanders Date: Mon, 2 Feb 2026 16:43:08 +0000 Subject: [PATCH] rose edit: docs --- changes.d/2808.feat.md | 3 +++ sphinx/installation.rst | 12 ++++++++++++ 2 files changed, 15 insertions(+) create mode 100644 changes.d/2808.feat.md diff --git a/changes.d/2808.feat.md b/changes.d/2808.feat.md new file mode 100644 index 000000000..deab003ec --- /dev/null +++ b/changes.d/2808.feat.md @@ -0,0 +1,3 @@ +The `rose edit` GUI has been restored to Rose 2. + +It is available as the pip-package `metomi-rose[edit]` (you will need to ensure GTK3 and `cairo` are installed), or the conda-forge package `metomi-rose` (which includes all of the required system dependencies). diff --git a/sphinx/installation.rst b/sphinx/installation.rst index 1c6519505..513046255 100644 --- a/sphinx/installation.rst +++ b/sphinx/installation.rst @@ -46,6 +46,17 @@ With ``pip``:: See the :ref:`Cylc installation instructions ` for more information. +PyGobject +""""""""" + +.. _pygobject installation instructions: https://pygobject.gnome.org/getting_started.html#ubuntu-logo-ubuntu-debian-logo-debian + +The :ref:`command-rose-config-edit` GUI requires PyGObject and its dependencies +(which include Cairo, GI and GTK) to be installed. + +These dependencies are included in the Conda package. If installing via uv/pip +you will need to follow the `pygobject installation instructions`_. + Git """ @@ -92,6 +103,7 @@ Rose with the ``graph`` optional dependency:: hosting services such as GitHub. Note Git is not automatically installed by the metomi-rose conda. + Configuring Rose ----------------