From 3a5c307e27fbed0246070620637c42b7701501d8 Mon Sep 17 00:00:00 2001 From: chloemackallah Date: Mon, 25 Sep 2023 15:48:35 +1000 Subject: [PATCH 1/3] code management & versioning --- Governance/create/create-basics.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/Governance/create/create-basics.md b/Governance/create/create-basics.md index 894293c..5938721 100644 --- a/Governance/create/create-basics.md +++ b/Governance/create/create-basics.md @@ -81,11 +81,11 @@ While similar to DMP in many ways, **data documentation** is a distinct purpose ## Code management & version control -Claire: -If your data is an analysis product, keep the code nearby the data or document where it can be accessed (snapshot the version of the code used to create this dataset) +Best practice for managing software of any kind starts with version controlled repositories. Git-based platforms (e.g., GitHub and GitLab instances such as the [NCI GitLab](https://git.nci.org.au/)) and APIs are the current standard, although SVN and other tools are also in use throughout climate science. Learning these tools are vital to software development, and the versioning native in these systems help ensure provenance, reproduction, and creating FAIR datasets for sharing and publication. +Releases (Git-based publications) of specific versions can be useful to complement published datasets or papers, however it is important to note that independent publication of code (e.g. via Zenodo) is required for a DOI and is recommended to ensure long-term access and reproducibility. -Paola: -Keep code under version control +Of course, code cannot exclusively exist in a repository. It is suggested (particularly if your data is an analysis product) to keep the code nearby the data (e.g. in the same parent directory) or document where it can be accessed in a readily available README file (also note the version of the code used to create the associated dataset!). -Chloe: -Versioning: https://acdguide.github.io/Governance/tech/versioning.html +Data should also be versioned, especially for more underpinning datasets such as model output & data products, however best practice in this domain is still evolving. CMIP data includes versioning at the variable level that uses date of file creation, however this is just one method. + +For more information on versioning, see https://acdguide.github.io/Governance/tech/versioning.html From 94dbeea2019e7de08cfc34a1e103dc29cbe123f1 Mon Sep 17 00:00:00 2001 From: chloemackallah Date: Mon, 25 Sep 2023 15:50:37 +1000 Subject: [PATCH 2/3] minor update --- Governance/create/create-basics.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Governance/create/create-basics.md b/Governance/create/create-basics.md index 5938721..b766bba 100644 --- a/Governance/create/create-basics.md +++ b/Governance/create/create-basics.md @@ -81,7 +81,7 @@ While similar to DMP in many ways, **data documentation** is a distinct purpose ## Code management & version control -Best practice for managing software of any kind starts with version controlled repositories. Git-based platforms (e.g., GitHub and GitLab instances such as the [NCI GitLab](https://git.nci.org.au/)) and APIs are the current standard, although SVN and other tools are also in use throughout climate science. Learning these tools are vital to software development, and the versioning native in these systems help ensure provenance, reproduction, and creating FAIR datasets for sharing and publication. +Best practice for managing software of any kind starts with *version controlled repositories*. Git-based platforms (e.g., GitHub and GitLab instances such as the [NCI GitLab](https://git.nci.org.au/)) and APIs are the current standard, although SVN and other tools are also in use throughout climate science. Learning these tools are vital to software development, and the versioning native in these systems help ensure provenance, reproduction, and creating FAIR datasets for sharing and publication. Releases (Git-based publications) of specific versions can be useful to complement published datasets or papers, however it is important to note that independent publication of code (e.g. via Zenodo) is required for a DOI and is recommended to ensure long-term access and reproducibility. Of course, code cannot exclusively exist in a repository. It is suggested (particularly if your data is an analysis product) to keep the code nearby the data (e.g. in the same parent directory) or document where it can be accessed in a readily available README file (also note the version of the code used to create the associated dataset!). From cd4217d4f6d7f516000138b8a779a8019c766c20 Mon Sep 17 00:00:00 2001 From: chloemackallah Date: Mon, 25 Sep 2023 15:51:04 +1000 Subject: [PATCH 3/3] ' --- Governance/create/create-basics.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Governance/create/create-basics.md b/Governance/create/create-basics.md index b766bba..406a072 100644 --- a/Governance/create/create-basics.md +++ b/Governance/create/create-basics.md @@ -81,7 +81,7 @@ While similar to DMP in many ways, **data documentation** is a distinct purpose ## Code management & version control -Best practice for managing software of any kind starts with *version controlled repositories*. Git-based platforms (e.g., GitHub and GitLab instances such as the [NCI GitLab](https://git.nci.org.au/)) and APIs are the current standard, although SVN and other tools are also in use throughout climate science. Learning these tools are vital to software development, and the versioning native in these systems help ensure provenance, reproduction, and creating FAIR datasets for sharing and publication. +Best practice for managing software of any kind starts with **version controlled repositories**. Git-based platforms (e.g., GitHub and GitLab instances such as the [NCI GitLab](https://git.nci.org.au/)) and APIs are the current standard, although SVN and other tools are also in use throughout climate science. Learning these tools are vital to software development, and the versioning native in these systems help ensure provenance, reproduction, and creating FAIR datasets for sharing and publication. Releases (Git-based publications) of specific versions can be useful to complement published datasets or papers, however it is important to note that independent publication of code (e.g. via Zenodo) is required for a DOI and is recommended to ensure long-term access and reproducibility. Of course, code cannot exclusively exist in a repository. It is suggested (particularly if your data is an analysis product) to keep the code nearby the data (e.g. in the same parent directory) or document where it can be accessed in a readily available README file (also note the version of the code used to create the associated dataset!).