|
| 1 | +.. ----------------------------------------------------------------------------- |
| 2 | + (c) Crown copyright Met Office. All rights reserved. |
| 3 | + The file LICENCE, distributed with this code, contains details of the terms |
| 4 | + under which the code may be used. |
| 5 | + ----------------------------------------------------------------------------- |
| 6 | +
|
| 7 | +.. _testdata: |
| 8 | + |
| 9 | +Adding Test Data |
| 10 | +================ |
| 11 | + |
| 12 | +.. note:: |
| 13 | + |
| 14 | + This page is a placeholder for information about test data. It is not yet |
| 15 | + complete and will be updated in due course. |
| 16 | + |
| 17 | + *These instructions apply to all Met Office managed systems and related |
| 18 | + external platforms (such as JULES data on JASMIN), though other sites may |
| 19 | + manage their test data differently.* |
| 20 | + |
| 21 | +.. important:: |
| 22 | + |
| 23 | + If you have questions about the process or concerns about the provenance of |
| 24 | + the data you want to include, please engage with the IAO as early as |
| 25 | + possible to prevent delays to your change later on. |
| 26 | + |
| 27 | +.. .. important:: **Attribution Metadata Policy** |
| 28 | +
|
| 29 | +.. If the change requires a new or updated file in ``LFRIC_DATA_DIR`` then you |
| 30 | +.. will need to work with the Information Asset Owner (IAO) to ensure that data |
| 31 | +.. in ``LFRIC_DATA_DIR`` includes clear attribution and licence metadata. |
| 32 | +.. Where possible, this should follow existing UM ``ANCILDIR`` conventions (`see |
| 33 | +.. below <prerequisites-section_>`_), with ``.attribution`` and ``.license`` |
| 34 | +.. files or equivalent NetCDF **global attributes** (at least, ``references``, |
| 35 | +.. ``license``, ``source``, and ``history``). Attribution must reflect the |
| 36 | +.. original data source and be provided by the data creators before deployment, |
| 37 | +.. share, or distribution. |
| 38 | +
|
| 39 | +.. It is treated as an **Information Asset / licensing requirement**, not just |
| 40 | +.. a best practice. |
| 41 | +
|
| 42 | +
|
| 43 | +For UM related datasets, please Email the `MIAO team <mailto:miao@metoffice.gov.uk>`_ |
| 44 | +to discuss the best way to share the data. |
| 45 | + |
| 46 | +.. _prerequisites-section: |
| 47 | + |
| 48 | +Prerequisites |
| 49 | +------------- |
| 50 | + |
| 51 | +Before adding test data, you should have a good understanding of the change you |
| 52 | +are making and the tests you will be adding. You should also have a good |
| 53 | +understanding of the codebase and the testing framework you will be using. |
| 54 | + |
| 55 | +Licensing and Attribution |
| 56 | +~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 57 | + |
| 58 | +All files require a licence and a record of where they have come |
| 59 | +from, both for legal and auditing purposes. In your request |
| 60 | +please describe where and how the data was generated, and the |
| 61 | +terms and conditions of its licence. |
| 62 | + |
| 63 | +Before any files can be deployed, they must be approved by an IAO |
| 64 | +and this cannot be done without information about the licencing |
| 65 | +terms. It is your responsibility as a developer to obtain this |
| 66 | +approval. |
| 67 | + |
| 68 | +Where the data is in netCDF format, it should use the global |
| 69 | +attributes described in the section below; data files in other |
| 70 | +formats should follow the existing UM ``ANCILDIR`` conventions. |
| 71 | +Attribution must reflect the original data source and be provided |
| 72 | +by the data creators before deployment, share, or distribution. |
| 73 | + |
| 74 | +Metadata |
| 75 | +~~~~~~~~ |
| 76 | + |
| 77 | +All file requirements should be recorded in or alongside the files being |
| 78 | +deployed. |
| 79 | + |
| 80 | +If a source file has a licence that imposes requirements on derived |
| 81 | +works, then any ancillary file (or an intermediate file used to generate an |
| 82 | +ancillary) counts as a derived work for the purposes of recording metadata. |
| 83 | + |
| 84 | +In cases where a file has been generated from multiple sources, the licences |
| 85 | +must be compatible with each other and it should be made clear where each |
| 86 | +licence/attribution/acknowledgement has come from. |
| 87 | + |
| 88 | +NetCDF Files |
| 89 | +^^^^^^^^^^^^ |
| 90 | + |
| 91 | +NetCDF files should have the relevant metadata included in the file itself. |
| 92 | +The metadata should include the following information: |
| 93 | + |
| 94 | +* The licence should be in a ``license`` global attribute as per |
| 95 | + `ESIP Attribute Convention for Data Discovery <https://wiki.esipfed.org/Attribute_Convention_for_Data_Discovery_1-3#Recommended>`_. |
| 96 | + |
| 97 | +* If there is a paper attribution requirement, the relevant paper(s) should be |
| 98 | + cited in the ``references`` global attribute as per |
| 99 | + `CF conventions <https://cfconventions.org/Data/cf-conventions/cf-conventions-1.11/cf-conventions.html#description-of-file-contents/>`_. |
| 100 | + |
| 101 | +* If there is an organisation attribution requirement, it should be in the |
| 102 | + ``institution`` global attribute (again, as per CF). |
| 103 | + |
| 104 | +* If there is any other attribution requirement (e.g. for an individual), it |
| 105 | + should be in the ``acknowledgement`` global attribute (again, as per ACCD). |
| 106 | + |
| 107 | +* If there are restrictions on usage (e.g. "research only"), these should be in |
| 108 | + a ``restrictions`` global attribute. |
| 109 | + |
| 110 | +Other Files |
| 111 | +^^^^^^^^^^^ |
| 112 | + |
| 113 | +* Licence should be in an accompanying plain text file with the same name as the |
| 114 | + data file, but with a ``.license`` suffix. |
| 115 | + |
| 116 | +* Attribution should be in an accompanying plain text file with the same name as |
| 117 | + the data file, but with a ``.attribution`` suffix. |
| 118 | + |
| 119 | +* Restrictions on usage (e.g. "research only") should be in an accompanying |
| 120 | + plain text file with the same name as the data file, but with a |
| 121 | + ``.restrictions`` suffix. |
| 122 | + |
0 commit comments