New hoomd example #14
Conversation
atravitz
requested review from
b-butler,
kidrahahjo and
pepak13
and removed request for
a team,
b-butler and
kidrahahjo
|
I really like this example! |
There was a problem hiding this comment.
Okay so the only other thing that might be worth adding, is to store the run_steps in the job document, that way we could introduce the concept that if you need to run the simulation longer, you just need to bump run_steps in the job doc. Maybe that is for a different tutorial, but it is one of the first things that people run into, they want to run their simulation longer since it hasn't equilibrated yet, but if they want to run it longer, they run into issues since it will mess up the state points.
I agree that it's good to encourage this as a default - I'll change it and add a note as to why we store it in the job doc. |
Co-authored-by: Mike Henry <mikehenry@boisestate.edu>
…nac-examples into new_hoomd_example
|
@atravitz I believe this is ready for another round of review? If yes, could you request that? Besides that, it appears that there are some build issues, any idea what might be going on? |
There was a problem hiding this comment.
@atravitz The style of the README has to follow a particular format. The continuous integration I added in #17 (and which used to be enabled long ago) parses the README and runs the commands it finds in code blocks beneath the heading # Usage. The updated text is definitely useful but the list formatting will need to look more like the previous. If you want help or an example, let me know.
Also should status.txt be removed (and added to .gitignore)?
Would breaking the commands into code blocks be sufficient? Should we have |
@atravitz I think so. You can refer to the other examples. The CI will run I don't think we need |
@bdice let me know if this looks good to you |
|
|
||
| @MyProject.operation | ||
| @MyProject.pre(initialized) | ||
| @MyProject.pre.isfile("init.gsd") |
There was a problem hiding this comment.
Would it be better to use after?
| @MyProject.pre.isfile("init.gsd") | |
| @MyProject.pre.after(initialize) |
There was a problem hiding this comment.
Personally I like using isfile here because it seems like the most explicit way of showing how pre/post conditions work.
Co-authored-by: Bradley Dice <bdice@bradleydice.com>
|
I'm going to go ahead and merge this. The PR been stalled for a long time and it is a significant improvement over the existing tutorial. |
For a while we've been needing to update some of these examples. Here's a proposed update to the HOOMD-blue example. The most notable change is the addition of a walk-through readme.