LACES-LAB / documentation

repo for lab documentation
0 stars 5 forks source link

Update MFEM tutorial description and add TOMMS tutorial #13

Closed Fuad-HH closed 4 months ago

Fuad-HH commented 5 months ago

I have added a few lines on TOMMS so that if someone new is asked to install TOMMS, they may find this helpful that he needs to get access first.

I've also added the instruction to build MFEM with cmake since MFEM website only gives instructions for make and users may have dig slightly deeper to get the cmake instructions. It may work as a quick reference for us.

Fuad-HH commented 5 months ago

Could you please give me some suggestions on what kind of tutorials for TOMMS and MFEM we can add? Because MFEM tutorials on their website are very comprehensive. And for TOMMS, I don't understand it fully to think of a tutorial. Instruction to run samples are already given in the TOMMS repo wiki.

jacobmerson commented 5 months ago

"tutorial" might not be the right section, but we should have any information about installation, etc. that is specific to us. For TOMMS, the installation instructions will be relevant to SCOREC machines, so just point at that documentation, so a new user to our lab can find it.

Everything is in the perspective of a new person joining the "LACES" team. So, if we can point them to the appropriate link it'll make the startup process just a bit easier. What you say is correct otherwise. We do not want to reinvent the wheel here.

Fuad-HH commented 5 months ago

"tutorial" might not be the right section, but we should have any information about installation, etc. that is specific to us. For TOMMS, the installation instructions will be relevant to SCOREC machines, so just point at that documentation, so a new user to our lab can find it.

Everything is in the perspective of a new person joining the "LACES" team. So, if we can point them to the appropriate link it'll make the startup process just a bit easier. What you say is correct otherwise. We do not want to reinvent the wheel here.

Yes, I was also thinking that all the installation process has gone to the tutorial section. But if we want to relocate them to a different place, that will be a lot of work. If you have any suggestions on doing this easily, please let me know. We can also change the name of the section as "Installation and Tutorials" if it really makes sense.

Fuad-HH commented 4 months ago

Do I need to add anything else?