search

FormingWorlds / PROTEUS

Coupled atmosphere-interior framework to simulate the temporal evolution of rocky planets.
https://fwl-proteus.readthedocs.io
Apache License 2.0
12 stars 1 forks source link

Long term archive of PROTEUS source #166

Closed lsoucasse closed 2 months ago

lsoucasse commented 2 months ago

It would be nice to setup an archiving process of old versions of PROTEUS, independently of Github, so we can make sure we never loose history, especially for submodules we have less control on. This could be done on a yearly basis, starting from early 2024 (i.e. before starting the eScience project).

nichollsh commented 2 months ago

Definitely a good idea.

It is possible to clone the entire history of a Git repository with the following method: https://stackoverflow.com/a/54040382. We could potentially upload it to OSF using their API.

lsoucasse commented 2 months ago

The git bundle command sounds attractive. But we have to separately bundle each of the submodules.

lsoucasse commented 2 months ago

I have uploaded a bundle of PROTEUS v24.04.04 with all associated submodules here. Could you try it @nichollsh and @timlichtenberg ? Once you download the folder, you can just run the script restore-proteus-v24.04.04.shand it will clone the PROTEUS repo with its submodules.

lsoucasse commented 2 months ago

I realize I could also add a bundle of the AGNI repository. But it is hard for me to choose the correct compatible version except from the date. Overall, I think it is something missing as we have no information in the doc which (minimal) AGNI version to use. Maybe something to fix @nichollsh ?

nichollsh commented 2 months ago

The restore PROTEUS functionality from the OSF folder seems to work well for me. Fast work!

Regarding the second point on AGNI compatibility: this has not been something that has ever been formalised. The PROTEUS docs instruct the user to clone the AGNI main branch, which I have tried to ensure is compatible with the current PROTEUS main branch, Going forward it should probably point to a particular tag, such as an AGNI release. Just as we have a get_socrates.sh script, we could add a script for getting AGNI. This could potentially be incorporated into the PROTEUS CLI.

lsoucasse commented 2 months ago

Just added a bundle of agni to the archive (version of March 28, commit tag c5ab86c).

timlichtenberg commented 2 months ago

Works like a charm! :-) Like we discussed today this archive should essentially be only for the past from now to be able to recreate the git history for when we start deleting larger items from the history.

lsoucasse commented 2 months ago

Thanks for your feedback. I am closing this issue now. We might set up later an automatic archiving process, on a yearly basis.