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

Transfer `surface_gases.py` to the new CALLIOPE package #171

Closed nichollsh closed 2 months ago

nichollsh commented 2 months ago

There has (and continues to be) significant scientific interest in the mass-balance equilibrium functionalities of surface_gases.py. It would therefore make sense to turn this into a standalone package so that it can be interacted-with more easily without installing all of PROTEUS.

Since this formulation will be mostly superseded by Atmodeller soon, any changes should probably avoid significant development.

nichollsh commented 2 months ago

@timlichtenberg does this sound okay to you?

timlichtenberg commented 2 months ago

Yes, right now is the best opportunity to do this. I had started to fork the code from Schlichting & Young (2022) here: https://github.com/FormingWorlds/CETO_fork. Jorick Lania will do a MSc project starting now essentially to compare the E&Y22 code to surface_gases.py. Optimally, they would be in the same repo with an already pre-set structure compatible with the rest of the PROTEUS ecosystem. My suggestion would be to create a new repo, copy surface_gases.py and the source files from https://github.com/FormingWorlds/CETO_fork into this new repo, and then Jorick can work in a branch of this repo on comparing the two with each other, while we already work on incorporating this into the wider PROTEUS framework.

Sound good?

timlichtenberg commented 2 months ago

Repo name optimally female… :> Ceto does that and is simple to pronounce. But anything in a similar direction is good as well.

nichollsh commented 2 months ago

I think it would make sense to keep CETO separate from the new module, since it's presumably something we won't be developing?

timlichtenberg commented 2 months ago

If you want it separate that's fine, but yes, I think there may be some development in the direction in the future. The two methods could be exchangeable as two options in one repo. If you think it makes more sense to keep them separate I am happy with that as well.

nichollsh commented 2 months ago

Let's keep it separate for now, and discuss merging them in the future, then. Moving surface_gases seems to be the main thing to do anyway.

nichollsh commented 2 months ago

https://github.com/FormingWorlds/CALLIOPE