-
Notifications
You must be signed in to change notification settings - Fork 83
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
📚 Docs: Add first version of PwRelaxWorkChain
how to
#934
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @mbercx . Think this is great to have. I just have two questions now that we restarted the docs from scratch and will start adding pieces by different authors.
I feel the tone of this addition is more that of a tutorial, rather than a how-to guide. Would it make sense to add this rather to the tutorials section? As you can see, the entry I added for PwCalculation
is in similar spirit to what you wrote here, in the sense that it is a complete and step-by-step instruction. The changing of relax type would be a great section for the how-to guide though.
Think we should also make some agreements up front on the language. Especially for how-to's, I think we shouldn't use the second person singular, but a more neutral language. If you prefer, for tutorial content, I think it could make sense the way you wrote it. This is always going to be heavily influenced by personal preference, but I think that if we want to have the docs be readable, they should be as consistent as possible, despite being written by different authors.
```python | ||
from aiida_quantumespresso.workflows.pw.relax import PwRelaxWorkChain | ||
|
||
code = orm.load_code('qe-7.2-pw@localhost') | ||
structure = orm.load_node(1) # FCC Silicon |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why not make it actually runnable?
```python | |
from aiida_quantumespresso.workflows.pw.relax import PwRelaxWorkChain | |
code = orm.load_code('qe-7.2-pw@localhost') | |
structure = orm.load_node(1) # FCC Silicon | |
```python | |
from ase.build import bulk | |
from aiida_quantumespresso.workflows.pw.relax import PwRelaxWorkChain | |
code = orm.load_code('qe-7.2-pw@localhost') | |
structure = orm.StructureData(ase=bulk('Si', 'diamond', 5.43)) # FCC Silicon |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Although having the structure is a bonus, in the end they probably still need to adapt the code ID. ^^
Thanks for the comments, @sphuber! This is exactly why I still left the PR as a WIP, to discuss how to properly structure the docs. 👍 📚 I completely agree that it is good to have a clear separation between tutorials and how-to's, although there will always be a bit of overlap. Also fine with rethinking the language. Let me have a crack at adapting this documentation, but also write down our policies on this so we can crystallise our approach. |
Thanks for this @mbercx ! I personally don't feel strongly about the language you choose here, but I do agree about the level of verbosity - I believe less is more here, both for users and for maintainers. As a first step, I would only add a tiny bit of extra information per worfklow - the minimum a new user needs to know which workflow to run, and any specific settings that cannot be left at their default values. Here are my suggestions
|
First version of the How-to section on the
PwRelaxWorkChain
. Describes basic usage via theget_builder_from_protocol()
method, as well as determining the basic degrees of freedom using theRelaxType
enum.