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

[WIP] Improvement of documentation #270

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

celinehalkali
Copy link

@celinehalkali celinehalkali commented Nov 26, 2024

  • Improvement of quick-start section.
  • Clearer installation instructions.

@JaGeo
Copy link
Collaborator

JaGeo commented Nov 26, 2024

Welcome @celinehalkali ! Don't forget to add yourself to the list of contributors!

@QuantumChemist QuantumChemist self-requested a review November 26, 2024 15:58
@QuantumChemist QuantumChemist added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 26, 2024
@QuantumChemist QuantumChemist linked an issue Nov 26, 2024 that may be closed by this pull request
@@ -17,7 +17,7 @@ This involves the following software packages:
We are also referring the user to the [installation guide of atomate2](https://materialsproject.github.io/atomate2/user/install.html) in order to setup the mandatory prerequisites to
be able to use `autoplex`.

After setting up `atomate2`, make sure to add `VASP_INCAR_UPDATES: {"NPAR": number}` in your ~/atomate2/config/atomate2.yaml file.
After setting up `atomate2`, make sure to add `VASP_INCAR_UPDATES: {"NPAR": number}` in your ~/atomate2/config/atomate2.yaml file.
Copy link
Collaborator

Choose a reason for hiding this comment

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

test comment

Comment on lines +61 to +64
**Celine Halkali** [![gh]][celinehalkali] (Documentation)\
Montanuniversität Leoben

[celinehalkali]: https://github.com/celinehalkali
Copy link
Collaborator

Choose a reason for hiding this comment

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

@JaGeo thank you for the reminder!
@celinehalkali 🥳

celinehalkali and others added 2 commits November 26, 2024 16:20
test commit

Co-authored-by: Christina Ertural <[email protected]>
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 enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improvement of documentation
3 participants