For computational materials science, you will generally have two environments to maintain. Your personal workstation and the HPC environment. I will assume that you will do more time-intensive calculation on a high-performance cluster (HPC) and analysis and development on a personal workstation. I have tried to make these instructions applicable for both Microsoft Windows users, Apple OSX users, and Linux users. However, I use an Apple laptop and a Windows desktop for personal use, so Linux instructions might be incorrect.
This tutorial assumes that you have a UNIX shell account, with a username password. For the purposes of this tutorial, variable flags will be assumed to be contained within angle brackets (e.g. <username>, <password>).
I used to do all my code development in vim, but I decided to standardize the workstation recommendations using a more modern tool.
Add the PlantUML. Get the correct one because the other one sucks.
This requires installing Java
Installation of PlantUML. Details can be seen in Software Design.