Installation Manuals

Using PlantUML in Jupyter Notebook

This year, we highly encourage everyone to PlantUML with Jupyter Notebook for the UML part. You can either install Jupyter Notebook with VSCode, or use it with Anaconda.

Please follow the following instructions for installation:

  1. Using Jupyter Notebook in VSCode: https://code.visualstudio.com/docs/datascience/jupyter-notebooks
  2. Using Jupyter Notebook with Anaconda: https://docs.anaconda.com/ae-notebooks/user-guide/basic-tasks/apps/jupyter/

While you can largely reuse and follow the Jupyter Notebook templete/example we provided, to use PlantUML in Jupyter Notebook you need install the iplantuml Python package: https://github.com/jbn/IPlantUML

Listed below are other ways (kept from last year) that you can use PlantUML. You can skip them if you decided to use Jupyter Notebook.

Installing PlantUML in VSCode

  1. Go to the Extensions page
  2. Type in PlantUML and Install jebbs.plantuml
  3. To create a PlantUML file:
    1. Click File | new Text File
    2. Select the language by pressing Ctrl + K , let go and then press M
    3. Type "PlantUML" and select it
  4. When you want to render your PlantUML script:
    1. Press Ctrl + Shift + P to open the palette
    2. Type "PlantUML"
    3. Select "PlantUML: Preview Current Diagram"

Installing PlantUML in CLion

  1. Go to File | Settings | Plugins
  2. Type "PlantUML Integration" and Install
    1. To create a new PlantUML file:
    2. Click File | new | file and create a <name>.puml file

Rendering Online

You can always access the online PlantUML Web Server to render your PlantUML instance.

Troubleshooting

On Linux you might get a rendering error if you are missing graphviz. To fix the error you only need to install the dependency:

sudo apt install graphviz