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.

Sign up for GitHub

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

Jump to bottom

Clean API and update documentation #127

Open
martin-schlipf opened this issue Jan 16, 2024 · 0 comments
Open

Clean API and update documentation #127

martin-schlipf opened this issue Jan 16, 2024 · 0 comments
Milestone
Release 1.0

Comments

@martin-schlipf
Copy link
Collaborator

martin-schlipf commented Jan 16, 2024 •
edited by sudarshanv01
Loading

  • Prepare py4vasp for a version 1.0 release by deciding which parts of the API are available.
  • Add more documentation for the public part of the API in particular examples.
  • Rename classes and methods in the generated documentation, so that they are called Calculation.dos.plot instead of data.Dos.plot
  • Write introductory documentation that explains the basics of py4vasp similar to the workshop tutorial
  • Change calculations to batch
@martin-schlipf martin-schlipf added this to the Release 1.0 milestone Jan 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
Release 1.0
Development

No branches or pull requests
1 participant
@martin-schlipf