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 of workflow capabilities #948

Open
ltalirz opened this issue May 30, 2023 · 2 comments
Open

documentation of workflow capabilities #948

ltalirz opened this issue May 30, 2023 · 2 comments

Comments

@ltalirz
Copy link
Member

ltalirz commented May 30, 2023

The lead of the documentation says

Compute a variety of material properties with the popular open source DFT code with automatic data provenance provided by AiiDA. Geometry optimizations, ground-state electronic structure, band structures, phonons, and much more.

I think this is exactly what a new user wants to read, but what is missing here is a link to https://aiida-quantumespresso.readthedocs.io/en/latest/howto/workflows/index.html .
The linked page then needs a minimalistic explanation on what workflow to use to do what (geo opt, electronic structure, band structure, phonons, ...).
I think a lot could be achieved here with 1-2 sentences per workflow + the autodocumentation functionality that shows the process inputs.

P.S. This is a bit off-topic, but are there or have there ever been plans for a heat capacity workflow?

@mbercx
Copy link
Member

mbercx commented May 30, 2023

Hi @ltalirz! The documentation is still severely lacking indeed, but we already have several PRs open with updates (#640; built on #946, and then #934; but this one will still need some restructuring after a first review from @sphuber).

Very happy to get feedback on these, and then continue working improving the docs! We should also do the same for the various aiida-quantumespresso children out there (ph, hp, epw, some still heavily indevelopment and all private for now, but I'm pushing to change that). There is a lot more you can do in the aiida-quantumespresso ecosystem that currently is simply not findable.

P.S. This is a bit off-topic, but are there or have there ever been plans for a heat capacity workflow?

Hmm, not as far as I'm aware, and I think I'm in the loop of quite a few developments out there. Maybe open an issue for it, with a rough description of the work chain outline? Thanks!

@mbercx mbercx self-assigned this May 30, 2023
@ltalirz
Copy link
Member Author

ltalirz commented May 30, 2023

Very happy to get feedback on these

Cheers, done!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants