Improve Maxwell documentation to setup and run #1076
Conversation
MaxThevenet
added
documentation
| HiPACE++: | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| #!/usr/bin/env zsh # Shell is assumed to be zsh |
There was a problem hiding this comment.
Would you need here also?
module ()
{
eval `modulecmd bash $*`
}
There was a problem hiding this comment.
With the proper configuration (maybe just the Shebang, but I am not sure what else is important here), we do not need this anymore. So I'd be in favor of not adding the module thingy in the documentation at the moment.
There was a problem hiding this comment.
If I source profile.hipace directly from the console it is not necessary, but if the source is in another script that is executed in a new shell (e.g. bash script.sh or ./script.sh) then it is needed.
There was a problem hiding this comment.
I see, I added this as a tip
There was a problem hiding this comment.
When I view this file here https://github.com/Hi-PACE/hipace/blob/5cdd01ac330a7a846771edb0fd21bdf69f813314/docs/source/building/platforms/maxwell_desy.rst , the module load stuff doesn't show up.
Issues reported by a user, suggestions/improvements welcome.