Updated install docs and other information

FormingWorlds / PROTEUS

Coupled atmosphere-interior framework to simulate the temporal evolution of rocky planets.

https://fwl-proteus.readthedocs.io

Apache License 2.0

11 stars 1 forks source link

Updated install docs and other information #103

Closed nichollsh closed 1 month ago

nichollsh commented 2 months ago

Tidied PROTEUS setup information
Moved troubleshooting to its own page
Updated steps as required for the submodules
Extra safety check in surface_gases.py, for when the model tries to "solve" for a gas with zero abundance

nichollsh commented 1 month ago

Hi @lsoucasse, thanks for catching the formatting/spelling issues. I have applied your suggestions.

lsoucasse commented 1 month ago

Great, also when I see the build, the troubleshooting section does not appear. I think you need to update the index.rst file.

lsoucasse commented 1 month ago

Also in the installation.rst file, replace [:ref:troubleshooting] by [:doc:troubleshooting] with appropriate link?

nichollsh commented 1 month ago

@lsoucasse, I have made these changes. There's still some strange behaviour where ReadTheDocs is creating bold subtitles for some reason. Do you know why this might be?

GitHub is showing it in the markdown too, actually. Maybe it does not like my use of * for bullet points.