Add section about VS Code & extensions

index.rst

@@ -28,6 +28,7 @@ This is documentation by and for members of the MOAD (Mesoscale Ocean and Atmosp
    analysis_repo
    jupyter
    github_notebooks_readme
+   vscode
    alliance-computing
    globus
    xios-2

vscode.rst

@@ -0,0 +1,106 @@
+.. Copyright 2018 – present by The UBC EOAS MOAD Group
+.. and The University of British Columbia
+..
+.. Licensed under a Creative Commons Attribution 4.0 International License
+..
+..   https://creativecommons.org/licenses/by/4.0/
+
+
+.. _MOAD-VSCode:
+
+*******
+VS Code
+*******
+
+`VS Code`_ is a free,
+open source,
+cross-platform,
+modern editor for code and text documents.
+It is developed by Microsoft.
+
+.. _VS Code: https://code.visualstudio.com/
+
+It has Git support built in.
+A large ecosystem of extensions provide support for many programming languages,
+file formats,
+and editing tasks.
+Of particular use in the MOAD group are:
+
+* the Python extension that includes support
+  for conda environments and the ability to edit Jupyter notebooks directly in VS Code
+* the Remote - SSH extension that enables you to use all of the features of VS Code
+  on directories and files located on remote machines including the Waterhole machines,
+  salish,
+  and the Alliance HPC clusters.
+
+
+Recommended Extensions
+======================
+
+All of these extensions can be installed from the Extensions sidebar.
+The links included below are so that you can confirm that you are installing
+the recommended one because there are many,
+many extensions with very similar names.
+
+Microsoft's Python Extension
+    Includes Jupyter support and many other features
+
+    https://marketplace.visualstudio.com/items?itemName=ms-python.python
+
+
+Microsoft's Jupyter Notebook Renderers
+    Renderers for various image/graph formats output in Jupyter notebooks
+
+    https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter-renderers
+
+
+Microsoft's Remote SSH Extension
+    Uses :program:`ssh` to open any directory/folder on a remote machine so that
+    its files can be edited in VS Code.
+
+    Includes an editing mode for :program:`ssh` configuration files.
+
+    https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh
+
+
+GitLens
+    Enhanced Git functionality and repository visualization
+
+    https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens
+
+
+Code Spell Checker
+    A basic spell checker that works well with code and documents
+
+    https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker
+
+
+Clipboard
+    A clipboard that remembers your last 200 copy/cut fragments
+
+    https://marketplace.visualstudio.com/items?itemName=Digoro.Clipboard
+
+
+Modern Fortran
+    Syntax highlighting, etc. for Fortran
+
+    https://marketplace.visualstudio.com/items?itemName=fortran-lang.linter-gfortran
+
+
+Rainbow CSV
+    Highlight in colour the columns of CSV and similar file types,
+    and other helpers for working with those types of files
+
+    https://marketplace.visualstudio.com/items?itemName=mechatroner.rainbow-csv
+
+
+reStructuredText Syntax highlighting
+    Syntax highlighting and document symbols for reStructuredText
+
+    https://marketplace.visualstudio.com/items?itemName=trond-snekvik.simple-rst
+
+
+vscode-pdf
+    Display PDF files in VS Code
+
+    https://marketplace.visualstudio.com/items?itemName=tomoki1207.pdf