Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation required #67

Open
marcelmbn opened this issue Oct 19, 2024 · 0 comments
Open

Documentation required #67

marcelmbn opened this issue Oct 19, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@marcelmbn
Copy link
Member

Why?

We need a dedicated documentation of mindlessgen to draw all explanations, possible features, etc. away from mindlessgen.toml and README.md towards an actual documentation.

What should be in there?

  • Enhanced explanation for each CLI flag/.toml file entry
  • Examples:
    • Most simplified run types with more or less default settings
    • Use cases for specific purposes:
      • Isomerization
      • E.g., only organic systems (generation of pseudo-biomolecules, as approached by @lukaswittmann)
      • Ternary oxide clusters
      • Actinide metal complexes
  • Limitations of mindlessgen
    • Very wide atom number range
    • Very large systems (> 60 atoms)
    • ...

How?

We could take inspiration from xtb, BayBE (probably best fit as it's Python), or CREST.

@marcelmbn marcelmbn added the documentation Improvements or additions to documentation label Oct 19, 2024
@marcelmbn marcelmbn added this to the v1.0.0 milestone Oct 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants