Skip to content

update most references to trac wiki #487

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Jenny Hickson (jennyhickson) merged 6 commits into from
Oct 30, 2025
Merged

update most references to trac wiki #487

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6eaed36
update most references to trac wiki
james-bruten-mo Oct 28, 2025
7a37510
Update source/Development/planning_your_change.rst
james-bruten-mo Oct 29, 2025
720e2c3
Update source/Development/planning_your_change.rst
james-bruten-mo Oct 29, 2025
f496be9
Update source/Development/rose_stem.rst
james-bruten-mo Oct 29, 2025
e1def76
Update source/FurtherDetails/coding_style.rst
james-bruten-mo Oct 29, 2025
897d807
review commetns
james-bruten-mo Oct 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion source/Development/TestSuites/lfric_apps.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Local testing:

Alternatively, a single application can be built and run locally using
`these instructions
<https://code.metoffice.gov.uk/trac/lfric_apps/wiki/local_builds>`__
<https://metoffice.github.io/lfric_apps/developer_guide/local_builds.html>`__

This test does not use rose or cylc and is particularly useful for checking
for compile errors while developing.
Expand Down
7 changes: 0 additions & 7 deletions source/Development/TestSuites/lfric_core.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,3 @@ developer suite).

It is also possible to run on a single platform, eg. ``-z group=ex1a``. To
select which meto EX machine is used, add ``-S USE_EX<AB/CD/Z>=true``.

.. tip::

For more details on LFRic testing including details of unit tests please
visit the `LFRic testing trac wiki page
<https://code.metoffice.gov.uk/trac/lfric/wiki/LFRicTechnical/Testing>`__.

3 changes: 1 addition & 2 deletions source/Development/documentation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,8 @@ alongside the code. This is then compiled using Sphinx into the webpages above.

The UM documentation papers are written in LaTeX and stored in a separate
repository. Guidelines for editing the UM documentation papers are available
`here <umdp>`_
:ref:`here <umdp>`.

.._ umdp: https://code.metoffice.gov.uk/trac/um/wiki/WorkingPractices/Documentation/UpdatingUMDPs

LFRic Apps and Core also use doxygen to document the code and all changes
should include appropriate doxygen changes to go with them. Doxygen guidelines
Expand Down
5 changes: 0 additions & 5 deletions source/Development/inputs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,6 @@ Rose GUI for users to switch it on. Additionally, sometimes the metadata needs
to be modified without changing a namelist variable. Guidance for updating the
metadata :ref:`is available <metadata_guidance>`.

..
Could do with thinking about how the JULES metadata could be included in this
document in the future, rather than the JULES wiki page
(https://code.metoffice.gov.uk/trac/jules/wiki/WorkingPractices#NamelistsUpgradeMacrosMetadata)

.. note::

JULES developers also need to :doc:`update the JULES documentation
Expand Down
14 changes: 6 additions & 8 deletions source/Development/metadata_guidance.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,16 +53,14 @@ have identical metadata regardless of the repository where they reside
(e.g. UM).

Shared JULES metadata is in the process of being migrated to
`rose-meta/jules-shared
<https://code.metoffice.gov.uk/trac/jules/browser/main/trunk/rose-meta/jules-shared>`__,
which resides in the JULES repository. The sub-directories are imported
by **rose-meta/um-atmos** and **rose-meta/jules-standalone** and is manually
synced with a copy in LFRic. Please see `Sharing JULES metadata
<https://code.metoffice.gov.uk/trac/jules/wiki/SharingJULESmetadata>`__ for
``rose-meta/jules-shared``, in the JULES repository. The sub-directories are
imported by **rose-meta/um-atmos** and **rose-meta/jules-standalone** and is
manually synced with a copy in LFRic. Please see `Sharing JULES metadata
<https://github.com/MetOffice/jules/wiki/sharing_jules_metadata>`__ for
more details including what should be in `jules-shared
<https://code.metoffice.gov.uk/trac/jules/wiki/SharingJULESmetadata#Whatsinjules-shared>`__
<https://github.com/MetOffice/jules/wiki/sharing_jules_metadata>`__
and in `jules-standalone, jules-lfric or um-atmos
<https://code.metoffice.gov.uk/trac/jules/wiki/SharingJULESmetadata#Whatsinjules-standalonejules-lfricorum-atmos>`__.
<https://github.com/MetOffice/jules/wiki/sharing_jules_metadata>`__.

@jennyhickson Jenny Hickson (jennyhickson) Oct 29, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did these want to still be sublinks to different parts of the page?

@james-bruten-mo James Bruten (james-bruten-mo) Oct 29, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah not sure why I didn't keep those

When developing shared JULES metadata, you will need :ref:`linked pull requests
<multirepo>`. The metadata migration is currently dictated by LFRic porting of
science, although the ultimate aim is to have a single source of truth.
Expand Down
3 changes: 1 addition & 2 deletions source/Development/planning_your_change.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,7 @@ something wrong. Please do seek advice.
coding standards and things to avoid, so it is useful for the developer to be
aware of these.

* `UMDP3 (UM and JULES FORTRAN)
<https://code.metoffice.gov.uk/doc/um/latest/umdp.html#003>`__
* :ref:`UMDP3 (UM and JULES Fortran) <umdp3>`
Comment thread
james-bruten-mo marked this conversation as resolved.
Outdated
* `LFRic Coding Styles
Comment thread
james-bruten-mo marked this conversation as resolved.
Outdated
<https://metoffice.github.io/lfric_core/how_to_contribute/index.html#how-to-contribute-index>`__
* `PEP 8 (Python) <https://legacy.python.org/dev/peps/pep-0008/>`__
Expand Down
2 changes: 1 addition & 1 deletion source/Development/rose_stem.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ manually configured, such as JULES.
.. note::

LFRic Apps has a `detailed set of wiki pages
Comment thread
james-bruten-mo marked this conversation as resolved.
Outdated
<https://code.metoffice.gov.uk/trac/lfric_apps/wiki/rose-stem>`__
<https://metoffice.github.io/lfric_apps/developer_guide/lfric_apps_rose_stem/index.html>`__
that document the structure and options available for their
suite.

Expand Down
16 changes: 1 addition & 15 deletions source/Development/temp_logicals.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,21 +115,7 @@ examining existing variables in the subroutines listed in the table above.

An upgrade macro and Rose metadata will be required to add the temporary
logical into the GUI and make it available to model users. See :ref:`inputs`
for further information. UM developers are also expected to fill in a
`temporary fixes summary template
<https://code.metoffice.gov.uk/trac/um/wiki/PageTemplates/TempFixesSummary>`__
and `the temporary logical table
<https://code.metoffice.gov.uk/trac/um/wiki/TempUMlogicals>`__ prior to the
review process.

..
Note: Have we got a page on upgrade macros? (i.e. brief instructions on how
to write one?) I wonder if we need one - I can only see a discussion on
what they are and how to apply one!

Should the temporary logical page and the summary wiki page be extended to
all repositories? I can't see one for JULES at the moment. This is
something to think about making consistent.
for further information.


After the release cycle
Expand Down
2 changes: 2 additions & 0 deletions source/Development/um_docs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _umdp:

Unified Model Documentation Papers (UMDPs)
==========================================

Expand Down
2 changes: 2 additions & 0 deletions source/FurtherDetails/coding_style.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _umdp3:
Comment thread
james-bruten-mo marked this conversation as resolved.
Outdated

==================
Software standards
==================
Expand Down
11 changes: 2 additions & 9 deletions source/Reviewers/codereview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,16 +110,9 @@ will include areas such as:
Generally this is about making sure the code complies with the relevant
style guides, and is consistent with the design of the code it sits in.

* `UMDP3 (UM and JULES FORTRAN)
<https://code.metoffice.gov.uk/doc/um/latest/umdp.html#003>`__,
* :ref:`UMDP3 (UM and JULES FORTRAN) <umdp3>`
* `LFRic Coding Styles
<https://code.metoffice.gov.uk/trac/lfric/wiki/LFRicTechnical/CodingStandards>`__
* `PEP 8 (Python) <https://legacy.python.org/dev/peps/pep-0008/>`__

`This page
<https://code.metoffice.gov.uk/trac/um/wiki/CodeReviewCribSheet>`__
provides some common (though UM-centric) things to confirm and think
about. It is not an exhaustive list, just a starting point.
<https://metoffice.github.io/lfric_core/how_to_contribute/coding_standards/fortran_coding_standards.html>`__

@jennyhickson Jenny Hickson (jennyhickson) Oct 29, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do the same here as above

@james-bruten-mo James Bruten (james-bruten-mo) Oct 29, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done


Final decision points and actions
---------------------------------
Expand Down
15 changes: 7 additions & 8 deletions source/Reviewers/howtocommit.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,9 +116,8 @@ To update the test suite for an upgrade macro, please run:
.. note::

The ``-\-jules-path`` option is only required if there are
linked `jules-shared
<https://code.metoffice.gov.uk/trac/jules/browser/main/trunk/rose-meta/jules-shared>`__
metadata changes.
linked changes to the ``rose-meta/jules-shared`` directory in the
Jules repository.

.. tab-item:: JULES

Expand Down Expand Up @@ -187,10 +186,10 @@ To update the test suite for an upgrade macro, please run:
this by checking out an appropriate working copy, and exporting the
environment variable ``ROSE_META_PATH=/path/to/core``.

For UM PRs, if there are linked `jules-shared
<https://code.metoffice.gov.uk/trac/jules/browser/main/trunk/rose-meta/jules-shared>`__
metadata changes then a suitable Jules source will need to be included
in the `ROSE_META_PATH` as described above.
For UM PRs, if there are linked changes to the
``rose-meta/jules-shared`` directory in the Jules repository, then a
suitable Jules source will need to be included in the `ROSE_META_PATH`
as described above.


.. dropdown:: Temporary Logical?
Expand Down Expand Up @@ -434,7 +433,7 @@ KGO differently*
#. Copy the new KGO to the correct locations:

`JULES KGO commands
<https://code.metoffice.gov.uk/trac/jules/wiki/KGOInstall>`__
<https://github.com/MetOffice/git_playground/wiki/Jules-KGO-Instructions>`__

#. Rerun the rose-stem tests to make sure nothing is broken.

Expand Down
2 changes: 1 addition & 1 deletion source/Reviewers/releases/mule_release.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Mule Release
.. note::

Additional details for the shumlib/mule releases can be seen `here
<https://code.metoffice.gov.uk/trac/um/wiki/mule_shumlib_install_details>`__
<https://github.com/MetOffice/git_playground/wiki/Shumlib-and-Mule-Additional-Install-Details>`__


Releasing Mule
Expand Down
2 changes: 1 addition & 1 deletion source/Reviewers/releases/shumlib_release.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Shumlib Release
.. note::

Additional details for the shumlib/mule releases can be seen `here
<https://code.metoffice.gov.uk/trac/um/wiki/mule_shumlib_install_details>`__
<https://github.com/MetOffice/git_playground/wiki/Shumlib-and-Mule-Additional-Install-Details>`__


Releasing Shumlib
Expand Down
7 changes: 3 additions & 4 deletions source/Reviewers/scitechreview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,9 @@ The Science / Technical reviewer should

* Ensure that the code has no unwanted side-effects

* Ensure that the code is written to the standards laid out in `UMDP3
<https://code.metoffice.gov.uk/doc/um/latest/papers/umdp_003.pdf>`__ or
`LFRic Coding Styles
<https://code.metoffice.gov.uk/trac/lfric/wiki/LFRicTechnical/CodingStandards>`__.
* Ensure that the code is written to the standards laid out in

@jennyhickson Jenny Hickson (jennyhickson) Oct 29, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and again 😄

@james-bruten-mo James Bruten (james-bruten-mo) Oct 29, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I was anticipating that!

:ref:`UMDP3 <umdp3>` or `LFRic Coding Styles
<https://metoffice.github.io/lfric_core/how_to_contribute/coding_standards/fortran_coding_standards.html>`__.

* Make sure that the in-line documentation is accurate and sufficient.

Expand Down