rivanna documentation issues
laszewsk opened this issue · 0 comments
Here how to fix readme …. so no confusion exists
a) create in https://github.com/cylondata/cylon/tree/main/conda/environments
cylon-rivanna-1.yaml
for firts method
b) create cylon-rivanna-1.yaml
for firts method
modify instructions to use thes yaml files.
Update documentation accordingly.
Do not include full text of yaml files in readme, but make instead links to the yaml fils saying that if details about verions ar needed, look into file
c) remove sentences that document that you need to modify things.
d) create a dire in which you keep the slurm scripts with appropriaete exports of variables
e) fix text so user can use existing yaml files and existing slurm scripts from the repository. Naturally make sure they are all checked in
d) recommendation also to create a Makefile with tarkets such as
make install
make test-sbatch
that installs and tests the makefile
e) appendix not needed as you can point to checked in yaml files.
f) use numbered sections
g) create in cylondata dir and file ./examples/rivana/Makefile
h) remove summit comment in readme.
This is typically best proctice on how to dela with different machines.
If you do this consitant with other machines that its realy easy to document
HOWEVER: better however would be to do for all installations
https://github.com/cylondata/cylon/tree/main/conda/environments/rivanna
https://github.com/cylondata/cylon/tree/main/conda/environments/macos
https://github.com/cylondata/cylon/tree/main/conda/environments/windows
https://github.com/cylondata/cylon/tree/main/conda/environments/ubuntu
https://github.com/cylondata/cylon/tree/main/conda/environments/....
THis will impact other documentation so I am not sure if you want to do that
This way you do not need an example dir and you can put the makefile and surmscript all in the same dir such as
https://github.com/cylondata/cylon/tree/main/conda/environments/rivanna