plumed2 icon indicating copy to clipboard operation
plumed2 copied to clipboard
verified publisher icon plumed

Update metatomic documentation for the new manual

Open Luthaf opened this issue 6 months ago • 5 comments

Description

This updates the syntax for admonition, and rephrase some of the installation instructions.

When building the manual locally with metatomic enabled, I get a 2.11 failed sticker, I guess this is because the model at path/to/model.pt does not exists?

Screenshot
Target release

I would like my code to appear in release v2.11

Type of contribution
  • [ ] changes to code or doc authored by PLUMED developers, or additions of code in the core or within the default modules
  • [ ] changes to a module not authored by you
  • [x] new module contribution or edit of a module authored by you
Copyright
  • [ ] I agree to transfer the copyright of the code I have written to the PLUMED developers or to the author of the code I am modifying.
  • [x] the module I added or modified contains a COPYRIGHT file with the correct license information. Code should be released under an open source license. I also used the command cd src && ./header.sh mymodulename in order to make sure the headers of the module are correct.
Tests
  • [ ] I added a new regtest or modified an existing regtest to validate my changes.
  • [x] I verified that all regtests are passed successfully on GitHub Actions.

Luthaf avatar Jun 18 '25 15:06 Luthaf

@Luthaf about the example if the file is not too big you could point to something in the regtest folder doing like: MODEL=regtest/...

carlocamilloni avatar Jun 19 '25 09:06 carlocamilloni

I just removed the model files in #1263, because these are treated as binary files by git, and need to be regenerated relatively often.

I could add another step to the doc build that generate a model when building docs if all dependencies are present, what do you think?

Luthaf avatar Jun 19 '25 12:06 Luthaf

that could be nice, but only if it is not time consuming because builing the manual is already a relatively long process. @gtribello what do you think?

carlocamilloni avatar Jun 19 '25 15:06 carlocamilloni

Generating the model would be pretty fast (~couple of seconds), but would require additional python dependencies. I can also live with the red sticker in there for now

Luthaf avatar Jun 19 '25 15:06 Luthaf

That sounds fine to me. If you want to have a chat about it drop me an email and we can arrange a time.

gtribello avatar Jun 20 '25 07:06 gtribello