Skip to content

Update documentation - #26

Merged
nichollsh merged 51 commits into
mainfrom
ks/update_docs
Jul 6, 2026
Merged

Update documentation#26
nichollsh merged 51 commits into
mainfrom
ks/update_docs

Conversation

@stuitje

@stuitje stuitje commented Jul 4, 2026

Copy link
Copy Markdown

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.py as 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

  • I have followed the contributing guidelines
  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • My changes generate no new warnings or errors
  • I have checked that the tests still pass on my computer
  • I have updated the docs, as appropriate
  • I have added tests for these changes, as appropriate
  • I have checked that all dependencies have been updated, as required

stuitje and others added 6 commits July 4, 2026 17:50
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>
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 nichollsh left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great! Thanks for adding this @stuitje - the documentation is now becoming very robust and useful.

  1. I've managed to follow the tutorial. I made some suggestions for improvement below.

  2. I also made some other minor tweaks to the documentation pages.

Otherwise, looks good.

Comment thread mkdocs.yml Outdated
Comment thread mkdocs.yml Outdated
Comment thread docs/Reference/proteus_spectral_file_reference.md Outdated
Comment thread docs/Tutorials/first_run.md
Comment thread docs/Tutorials/first_run.md
Comment thread docs/Tutorials/first_run.md Outdated
Comment thread docs/Tutorials/first_run.md Outdated
Comment thread docs/Tutorials/first_run.md
Comment thread docs/Tutorials/first_run.md Outdated
Comment thread docs/Tutorials/first_run.md Outdated
@nichollsh

Copy link
Copy Markdown
Member

But also maybe @timlichtenberg will have some suggestions, as he also has experience using SOCRATES.

stuitje and others added 2 commits July 5, 2026 17:55
Co-authored-by: Harrison Nicholls <32022679+nichollsh@users.noreply.github.com>
Co-authored-by: Harrison Nicholls <32022679+nichollsh@users.noreply.github.com>
@stuitje

stuitje commented Jul 5, 2026

Copy link
Copy Markdown
Author

Great! Thanks for adding this @stuitje - the documentation is now becoming very robust and useful.

  1. I've managed to follow the tutorial. I made some suggestions for improvement below.

  2. I also made some other minor tweaks to the documentation pages.

Otherwise, looks good.

Thanks Harrison for the thorough review, very useful! I will get on it :)

@stuitje

stuitje commented Jul 5, 2026

Copy link
Copy Markdown
Author

But also maybe @timlichtenberg will have some suggestions, as he also has experience using SOCRATES.

Ah good I will add him as a reviewer.

@stuitje
stuitje requested a review from timlichtenberg July 5, 2026 15:57
stuitje and others added 9 commits July 5, 2026 21:21
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>
@nichollsh

Copy link
Copy Markdown
Member

@stuitje let me know when this is ready for another review

@stuitje

stuitje commented Jul 6, 2026

Copy link
Copy Markdown
Author

@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!

@stuitje
stuitje requested a review from nichollsh July 6, 2026 10:32
@nichollsh
nichollsh merged commit f42ddec into main Jul 6, 2026
2 checks passed
@nichollsh

Copy link
Copy Markdown
Member

Great - thanks @stuitje. The CLA check was stuck, for some reason, so I approved and force-merged the branch.

@stuitje

stuitje commented Jul 6, 2026

Copy link
Copy Markdown
Author

Great - thanks @stuitje. The CLA check was stuck, for some reason, so I approved and force-merged the branch.

thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update SOCRATES docs

3 participants