Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
47 changes: 47 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Handle line endings automatically for files detected as text
# and leave all files detected as binary untouched.
* text=auto

# Binaries
*.nc binary
*.png binary

# Fortran files
*.f text diff=fortran
*.for text diff=fortran
*.f90 text diff=fortran
*.F90 text diff=fortran
*.f95 text diff=fortran
*.f03 text diff=fortran
*.x90 text diff=fortran
*.X90 text diff=fortran
*.t90 text diff=fortran
*.T90 text diff=fortran
*.pf text diff=fortran
*.PF text diff=fortran

# Enable syntax highlighting for files with `.pf` extensions.
#
*.pf linguist-language=fortran-free-form
*.pf linguist-detectable=true
*.pf linguist-documentation=false

*.PF linguist-language=fortran-free-form
*.PF linguist-detectable=true
*.PF linguist-documentation=false

*.x90 linguist-language=fortran-free-form
*.x90 linguist-detectable=true
*.x90 linguist-documentation=false

*.X90 linguist-language=fortran-free-form
*.X90 linguist-detectable=true
*.X90 linguist-documentation=false

*.t90 linguist-language=fortran-free-form
*.t90 linguist-detectable=true
*.t90 linguist-documentation=false

*.T90 linguist-language=fortran-free-form
*.T90 linguist-detectable=true
*.T90 linguist-documentation=false
139 changes: 94 additions & 45 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,61 +1,110 @@
# Description
# PR Summary

<!--
Please include a summary of the changes and the related issue. Please also include relevant motivation and context.
List any dependencies that are required for this change.
If there is additional detail included in the linked issue please note that here so a reviewer knows to check.
Sci/Tech Reviewer: <!-- SR id, filled when known (e.g. @octocat) -->
Code Reviewer: <!-- CR id, filled by SSD/CCD (e.g. @octocat) -->

<!-- To be completed by the developer -->

<!-- Provide a brief description of the changes in this PR, including any notes
useful for reviewers -->

<!-- List any linked PRs here
- linked MetOffice/<REPO-NAME>#<pr-number>
-->

## Linked issues
<!--
Linked issues should include issues on this repo and on any other repos where the change has an
affect (e.g. tickets linked between lfric_core and lfric_apps
<!-- List any blocking PRs or issues to be closed here
- is blocked-by #pr-number
- blocks #pr-number
- closes #issue-number (auto-closes the issue)
- fixes #issue-number (auto-closes the issue)
- is related to #issue-number
-->

Closes # (issue) <!-- Can be of the following forms Close/s/d #123 Fix/es/ed #123 or Resolve/s/d #123 (e.g. Closes #123) -->
## Code Quality Checklist

## Developer tags
<!--
Please include tags of any developers who should be notified about this PR
Format: @github_user_name
-->
(_Some checks are automatically carried out via the CI pipeline_)

## Type of change
- [ ] I have performed a self-review of my own code
- [ ] My code follows the project's
[style guidelines](https://metoffice.github.io/lfric_core/how_to_contribute/index.html#how-to-contribute-index)
- [ ] Comments have been included that aid undertanding and enhance the
readability of the code
- [ ] My changes generate no new warnings

- [ ] New feature (non-breaking change which adds functionality).
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected).
- [ ] This change requires a documentation update.
## Testing

# How has this been tested?
- [ ] I have tested this change locally, using the LFRic Core rose-stem suite
- [ ] If required (eg. API changes) I have also run the LFRic Apps test suite
using this branch
- [ ] If any tests fail (rose-stem or CI) the reason is understood and
acceptable (eg. kgo changes)
- [ ] I have added tests to cover new functionality as appropriate (eg. system
tests, unit tests, etc.)
- [ ] Any new tests have been assigned an appropriate amount of compute resource
and have been allocated to an appropriate testing group (i.e. the
developer tests are for jobs which use a small amount of compute resource
and complete in a matter of minutes)

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.
<!-- Describe other testing performed (if applicable) -->

- [ ] New tests have been added.
- [ ] Tests have been modified to accommodate this change.
- [ ] GitHub workflows have been changed or added.
### trac.log

# Checklist:
<!-- Paste your trac.log from testing output here -->

- [ ] The change has been checked for design compliance by an experienced SSE
<!-- All none trivial tickets should be seen by an appropriately experienced
SSE as part of a design review or as part of the normal review process -->
- [ ] My code follows the style guidelines of this project.
- [ ] I have commented my code, particularly in hard-to-understand areas.
- [ ] I have made corresponding changes to the documentation.
- [ ] My changes generate no new warnings.
- [ ] I have added tests that prove my fix is effective or that my feature works.
- [ ] New and existing unit tests pass locally with my changes, for both debug and optimised builds.
- [ ] No AI tools have been used in the creation of this change.
## Security Considerations

## Reasoning on why any of the above boxes have not been checked
<!--
Please provide reasoning on why any of the above checklist have not been ticked
(e.g. what are the warnings and why is this expected)
-->
- [ ] I have reviewed my changes for potential security issues
- [ ] Sensitive data is properly handled (if applicable)
- [ ] Authentication and authorisation are properly implemented (if applicable)

## Performance Impact

- [ ] Performance of the code has been considered and, if applicable, suitable
performance measurements have been conducted

## AI Assistance and Attribution

- [ ] Some of the content of this change has been produced with the assistance
of _Generative AI tool name_ (e.g., Met Office Github Copilot Enterprise,
Github Copilot Personal, ChatGPT GPT-4, etc) and I have followed the
[Simulation Systems AI policy](https://metoffice.github.io/simulation-systems/FurtherDetails/ai.html)
(including attribution labels)

<!-- If AI has been used, please provide more details here -->

## Documentation

- [ ] Where appropriate I have updated documentation related to this change and
confirmed that it builds correctly

## PSyclone Approval

- [ ] If you have edited any PSyclone-related code (eg. PSyKAl-lite, Kernel
interface, optimisation scripts, LFRic data structure code) then please
contact the
[tooscollabdevteam@metoffice.gov.uk](tooscollabdevteam@metoffice.gov.uk)

# Sci/Tech Review

<!-- To be completed by the Sci/Tech Reviewer -->
<!-- May be skipped for trivial tickets -->

- [ ] I understand this area of code and the changes being added
- [ ] The proposed changes correspond to the pull request description
- [ ] Documentation is sufficient (do documentation papers need updating)
- [ ] Sufficient testing has been completed

_Please alert the code reviewer via a tag when you have approved the SR_

# Code Review

# Review Checks (To be filled in by the reviewer/s)
<!-- To be completed by the Code Reviewer -->

- [ ] Has the developer completed the appropriate sections above?
- [ ] Is the change compliant with LFRic Core principles?
- [ ] Is the testing coverage sufficient?
- [ ] Have any technical debt workarounds identified had issues opened and interested parties notified?
- [ ] All dependencies have been resolved
- [ ] Related Issues have been properly linked and addressed
- [ ] CLA compliance has been confirmed
- [ ] Code quality standards have been met
- [ ] Tests are adequate and have passed
- [ ] Documentation is complete and accurate
- [ ] Security considerations have been addressed
- [ ] Performance impact is acceptable
11 changes: 11 additions & 0 deletions .github/workflows/check-cr-approved.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: Check CR approved

on:
pull_request_review:
types: [submitted, edited, dismissed]
workflow_dispatch:

jobs:
check_cr_approved:
if: ${{ github.event.pull_request.number }}
uses: MetOffice/growss/.github/workflows/check-cr-approved.yaml@main
10 changes: 10 additions & 0 deletions .github/workflows/cla-check.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: Legal

on:
pull_request_target:

jobs:
cla:
uses: MetOffice/growss/.github/workflows/cla-check.yaml@main
with:
runner: 'ubuntu-24.04'
17 changes: 17 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,23 @@ documentation/build
# vscode
.vscode

# vi/vim
*~
*.swp
*.swo

# Emacs backup files
.#*
\#*#

# Python
__pycache__
*.pyc
.pytest_cache

# LFRic CL Builds
applications/**/bin
applications/**/working
applications/**/example*/
science/**/bin
science/**/working
6 changes: 6 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Contributors

| GitHub user | Real Name | Affiliation | Date |
| ----------- | --------- | ----------- | ---- |
| james-bruten-mo | James Bruten | Met Office | 2025-12-09 |
| jennyhickson | Jenny Hickson | Met Office | 2025-12-10 |
30 changes: 0 additions & 30 deletions LICENCE.original

This file was deleted.

53 changes: 41 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,47 @@
LFRic Core
==========
[![Docs](https://github.com/MetOffice/lfric_core/actions/workflows/deploy-docs.yml/badge.svg?branch=main)](https://github.com/MetOffice/lfric_core/actions/workflows/deploy-docs.yml)
# LFRic Core

Location for LFRic infrastructure documentation. The LFRic infrastructure
source code will be migrated from its current Subversion repository to the
``main`` branch in November 2025.
[![ci](https://github.com/MetOffice/lfric_core/actions/workflows/ci.yml/badge.svg)](https://github.com/MetOffice/lfric_core/actions/workflows/ci.yml)

On the Met Office Azure Spice machine the main LFRic module environment
contains all the required packages to build the documentation. To build use
Location for LFRic infrastructure source code and documentation

On the Met Office Azure Spice machine the main LFRic module environment
contains all the required packages to build the documentation. To build use
`make html` in the documentation directory. `make help` will give you the other
options available. Additionally, `make deploy` will build a copy of the
options available. Additionally, `make deploy` will build a copy of the
documentation and deploy it to a directory in `$(HOME)/public_html` named after
the git branch.

Any changes should be developed on a fork of the `main` branch. Do not
target the `trunk` branch as this is currently used to synchronise subversion
`trunk`, and we will remove this branch following git migration in November 2025.
## Contributing Guidelines

Welcome!

The following links are here to help set clear expectations for everyone
contributing to this project. By working together under a shared understanding,
we can continuously improve the project while creating a friendly, inclusive
space for all contributors.

### Contributors Licence Agreement

Please see the
[Momentum Contributors Licence Agreement](https://github.com/MetOffice/Momentum/blob/main/CLA.md)

Agreement of the CLA can be shown by adding yourself to the CONTRIBUTORS file
alongside this one, and is a requirement for contributing to this project.

### Code of Conduct

Please be aware of and follow the
[Momentum Code of Coduct](https://github.com/MetOffice/Momentum/blob/main/docs/CODE_OF_CONDUCT.md)

### Working Practices

This project is managed as part of the Simulation Systems group of repositories.

Please follow the Simulation Systems
[Working Practices.](https://metoffice.github.io/simulation-systems/index.html)

Questions are encouraged in the Simulation Systems
[Discussions.](https://github.com/MetOffice/simulation-systems/discussions)

Please be aware of and follow the Simulation Systems
[AI Policy.](https://metoffice.github.io/simulation-systems/FurtherDetails/ai.html)
34 changes: 0 additions & 34 deletions ReadMe

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
##############################################################################
# Copyright (c) 2017, Met Office, on behalf of HMSO and Queen's Printer
# For further details please refer to the file LICENCE.original which you
# For further details please refer to the file LICENCE which you
# should have received as part of this distribution.
##############################################################################

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
##############################################################################
# Copyright (c) 2017, Met Office, on behalf of HMSO and Queen's Printer
# For further details please refer to the file LICENCE.original which you
# For further details please refer to the file LICENCE which you
# should have received as part of this distribution.
##############################################################################

Expand Down
Loading