Add a web docs page explaining the API changes and how to update.

Cambridge-ICCS / FTorch

A library for directly calling PyTorch ML models from Fortran.

https://cambridge-iccs.github.io/FTorch/

MIT License

79 stars 15 forks source link

Add a web docs page explaining the API changes and how to update. #144

Closed jatkinson1000 closed 5 months ago

jatkinson1000 commented 5 months ago

This PR adds a web docs page explaining the API changes and how to update following the breaking changes of #136 and #143

This can then be sent to known users to help them update.

dorchard commented 5 months ago

Alongside this perhaps we should bump the package number here: https://github.com/Cambridge-ICCS/FTorch/blob/ac4c14f307e79a147e377b8311ea40af4bd7ec34/src/CMakeLists.txt#L4 And perhaps a change to switch to semantic versioning?

jatkinson1000 commented 5 months ago

We could, but I am not sure it carries much meaning since we haven't updated it so far... My plans were to make a JOSS release v1.0.0 and then be more rigorous from that point.

jatkinson1000 commented 5 months ago

Thanks @TomMelt I will wait for Joe to have a final look over #143 and then merge this after that goes in.

I'm collating a list of users to email so please add any users you are aware of that I need to email here @dorchard @jwallwork23:

Laura Mansfield and Stanford
Will Chapman and NCAR
H. Heuer and ICON
vbalmer
WaveWatch 3

jatkinson1000 commented 5 months ago

Minor Aesthetic changes to the webpage and added a note to the README to highlight until v1.0.0. Issue #146 opened to remind us to revert these changes after a suitable period.