Skip to content
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.

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

Create acceptance test data repository and documentation #1849

Open
bayliffe opened this issue Jan 11, 2023 · 6 comments
Open

Create acceptance test data repository and documentation #1849

bayliffe opened this issue Jan 11, 2023 · 6 comments
Assignees
Labels

Comments

@bayliffe
Copy link
Contributor

bayliffe commented Jan 11, 2023

To improve collaboration we are aiming to share the acceptance test data in an accessible repository. The data within this repository will also be plotted in accompanying documentation, helping to give context.

Acceptance criteria:

  • Create a separate acceptance test data repository within metoppv; populate with a small subset of reduced domain for testing if the majority of data has yet to be shrunk.
  • Add github actions to the repository to build simple documentation on read-the-docs that includes plots of the acceptance test data. Plots include:
    • an enlarged area plot that provides spatial context for the small acceptance test data region (see https://github.com/metoppv/mo-blue-team/issues/426)
    • a plot of the acceptance test data region showing details
    • a record of the x and y spacing, so that acceptance test data that makes use of thinned spatial coordinates can be identified more easily.
  • Github actions should rebuild the plots documentation on PR merge, ideally only regenerating plots for changed data to reduce github action time use.
  • Add documentation to the IMPROVER Developer Guide detailing how to add / modify acceptance test data.
  • Add a link to the IMPROVER Documentation to the new acceptance test data documentation. (Using this approach removes any need for linking PRs etc, the documentation will always reflect whatever is actually merged into the acceptance test data master).
  • Ensure any documentation pointing to this repository is updated if we chose to change its location / structure.
@NMC-DAVE
Copy link

NMC-DAVE commented Feb 2, 2023

Hi bayliffe:
That's great work. When can we access the acceptance test data.
Thanks very much.
Dave

@bayliffe
Copy link
Contributor Author

bayliffe commented Feb 2, 2023

@NMC-DAVE we are working on shrinking file sizes and improving the documentation such that we can host the acceptance test data online. We don't currently know when this work will be complete. I will make a note to tag you in the eventual release so that you are aware.

@NMC-DAVE
Copy link

NMC-DAVE commented Feb 3, 2023

Thanks very much! Waiting for that.

@bayliffe bayliffe self-assigned this Mar 13, 2023
@bayliffe
Copy link
Contributor Author

Notes:

  • we won't be able to publish any documentation to read-the-docs until any repository we create is public, rather than private.
  • we may want to store the images generated for documentation in another repository specifically for that purpose to ensure we don't swell the size of the acceptance test data repository; we can couple the two together with github actions I believe.

@bayliffe
Copy link
Contributor Author

Ben Fitzpatrick suggested one of the following licences for this repository:

https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/
https://creativecommons.org/licenses/by/4.0/

I have reached out to Anja at the Bureau to see if they prefer the second non-UK government licence.

@bayliffe bayliffe removed the Paused label Dec 20, 2023
@bayliffe
Copy link
Contributor Author

This repository has now been made public. There is plenty of work remaining here associated with documentation and actions. We may also look at moving this repository of use git-lfs and integrate it more closely with the main IMPROVER repository in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants