Update documentation - #26
Conversation
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
nichollsh
left a comment
There was a problem hiding this comment.
Great! Thanks for adding this @stuitje - the documentation is now becoming very robust and useful.
-
I've managed to follow the tutorial. I made some suggestions for improvement below.
-
I also made some other minor tweaks to the documentation pages.
Otherwise, looks good.
|
But also maybe @timlichtenberg will have some suggestions, as he also has experience using SOCRATES. |
Thanks Harrison for the thorough review, very useful! I will get on it :) |
Ah good I will add him as a reviewer. |
Co-authored-by: Harrison Nicholls <32022679+nichollsh@users.noreply.github.com>
Co-authored-by: Harrison Nicholls <32022679+nichollsh@users.noreply.github.com>
Co-authored-by: Harrison Nicholls <32022679+nichollsh@users.noreply.github.com>
Co-authored-by: Harrison Nicholls <32022679+nichollsh@users.noreply.github.com>
|
@stuitje let me know when this is ready for another review |
It is now! I addressed all comments and also updated the README since it was still, for a large part, the metoffice README. Thanks Harrison! |
|
Great - thanks @stuitje. The CLA check was stuck, for some reason, so I approved and force-merged the branch. |
thank you! |
Description
This PR updates the documentation to professionalise the layout – and add certain features also recently added to the PROTEUS docs – and add a bibliography and tutorial.
The installation instructions have been updated as well, and there is a getting started page. Closes #25 .
@nichollsh if you have time, it would be nice if you could go over the tutorial in particular, as I am not a SOCRATES expert. It is based on python, as that is what most people will likely be familiar with, and uses
python/nctools.pyas already present in the repo. I also added a requirements file inside the python directory for necessary dependencies. I made it by iterating with Claude Sonnet 5.0 using the JANUS source code and the user guide, and after many modifications, it runs well for me and produces the desired output.Validation of changes
I built the website locally on Chrome, Safari, Firefox, and also built the mobile version locally on Firefox via an online tool.
Checklist