From 59978416328fb723b3856c4f08c4fce0d0b843f1 Mon Sep 17 00:00:00 2001 From: "J. George" Date: Mon, 6 May 2024 20:07:03 +0200 Subject: [PATCH 1/4] Create 0017-how-to-treat-old-codes --- decisions/0017-how-to-treat-old-codes | 69 +++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 decisions/0017-how-to-treat-old-codes diff --git a/decisions/0017-how-to-treat-old-codes b/decisions/0017-how-to-treat-old-codes new file mode 100644 index 0000000..cd649af --- /dev/null +++ b/decisions/0017-how-to-treat-old-codes @@ -0,0 +1,69 @@ +--- +# Configuration for the Jekyll template "Just the Docs" +parent: Decisions +nav_order: 1 +title: Template +layout: home + +# These are optional elements. Feel free to remove any of them. +# status: {proposed | rejected | accepted | deprecated | … | superseded by [ADR-0005](0005-example.md)} +# date: {YYYY-MM-DD when the decision was last updated} +# deciders: {list everyone involved in the decision} +# consulted: {list everyone whose opinions are sought (typically subject-matter experts); and with whom there is a two-way communication} +# informed: {list everyone who is kept up-to-date on progress; and with whom there is a one-way communication} +--- + + +# {short title of solved problem and solution} + +## Context and Problem Statement + +Some codes in the context of the Materials Project have only been developed based on short-term funding, and long-term support is hard/impossible to guarantee. +This code might still be used in the community. One of the recent example codes is Matminer that triggered the discussion. + + +## Decision Drivers + +* These codes are still useful to the community +* There will likely not be any long-term funding for such codes + +## Considered Options + +### Pin to specific versions of the dependencies and then release a final version +* Good as the code can still be used +* Bad as it might not be easy to use together with other software +### Transfer code ownership to a fork outside of MP (if someone wants to take over code) +* Good as the code will still be maintained +### Give maintaining rights to people outside of MP +* Good as more people can merge and contribute +* Not clear how such a decision can be made +### Ask on the repo if someone might want to take over +* Good as someone else might maintain the code in the future +* Connected with transferring code ownership to someone else + +## Decision Outcome + +Chosen option: "{title of option 1}", because +{justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force {force} | … | comes out best (see below)}. + + + +## Implementation Plan + +{List changes to be made in affected codes, as applicable, or list "N/A"} + +- [ ] `pymatgen`: ... +- [ ] `atomate2`: ... +- [ ] `emmet`: ... +- [ ] `crystal-toolkit`: ... +- [ ] `jobflow`: ... +- [ ] `maggma`: ... + + +## More Information + +{You might want to provide additional evidence/confidence for the decision outcome here and/or + document the team agreement on the decision and/or + define when this decision when and how the decision should be realized and if/when it should be re-visited and/or + how the decision is validated. + Links to other decisions and resources might here appear as well.} From 7eb7796d5deec7fd6887c2a294be06247d6c0300 Mon Sep 17 00:00:00 2001 From: "J. George" Date: Sun, 12 May 2024 00:35:36 +0200 Subject: [PATCH 2/4] Rename 0017-how-to-treat-old-codes to 0027-how-to-treat-old-codes --- .../{0017-how-to-treat-old-codes => 0027-how-to-treat-old-codes} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename decisions/{0017-how-to-treat-old-codes => 0027-how-to-treat-old-codes} (100%) diff --git a/decisions/0017-how-to-treat-old-codes b/decisions/0027-how-to-treat-old-codes similarity index 100% rename from decisions/0017-how-to-treat-old-codes rename to decisions/0027-how-to-treat-old-codes From ceb01e8435fd0cc0127f03576941b2e6e374f48f Mon Sep 17 00:00:00 2001 From: "J. George" Date: Mon, 1 Jul 2024 19:53:30 +0200 Subject: [PATCH 3/4] Rename 0027-how-to-treat-old-codes to 0027-how-to-retire-old-codes --- .../{0027-how-to-treat-old-codes => 0027-how-to-retire-old-codes} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename decisions/{0027-how-to-treat-old-codes => 0027-how-to-retire-old-codes} (100%) diff --git a/decisions/0027-how-to-treat-old-codes b/decisions/0027-how-to-retire-old-codes similarity index 100% rename from decisions/0027-how-to-treat-old-codes rename to decisions/0027-how-to-retire-old-codes From 7ffeb056f330f885e76526f49bf0a80aaa091c1c Mon Sep 17 00:00:00 2001 From: "J. George" Date: Mon, 1 Jul 2024 19:56:10 +0200 Subject: [PATCH 4/4] Update 0027-how-to-retire-old-codes --- decisions/0027-how-to-retire-old-codes | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/decisions/0027-how-to-retire-old-codes b/decisions/0027-how-to-retire-old-codes index cd649af..45af008 100644 --- a/decisions/0027-how-to-retire-old-codes +++ b/decisions/0027-how-to-retire-old-codes @@ -29,7 +29,7 @@ This code might still be used in the community. One of the recent example codes ## Considered Options -### Pin to specific versions of the dependencies and then release a final version +### Use specific versions of the dependencies (via toml or setup.py-based installations) and then release a final version (or release candidate) * Good as the code can still be used * Bad as it might not be easy to use together with other software ### Transfer code ownership to a fork outside of MP (if someone wants to take over code)