R, MATLAB, and Julia in HPC

This repository contains the source code for the UPPMAX/HPC2N R, MATLAB, and Julia in HPC course

Getting PDFs of the material

You can clone the repository: git clone https://github.com/UPPMAX/R-matlab-julia-HPC.git

After doing that, you can convert the .rst files to .pdf files with this online tool: https://cloudconvert.com/rst-to-pdf

The documentation files you see on the rendered pages (https://uppmax.github.io/R-matlab-julia-HPC/) are found under R-matlab-julia-HPC/docs/<language>.

Build locally

Clone the repository and navigate to the root of it:

git clone https://github.com/UPPMAX/R-matlab-julia-HPC.git
cd R-matlab-julia-HPC

Create a python venv and activate it:

mkdir env
python -m venv env
source env/bin/activate

Tip

Add env/ to your ~/.gitignore, environments are meant to be reproduced from specifications and not meant to be checked in to version control.

In your new venv (your console prompt should assure you it has been properly activated), update pip and install the requirements:

pip install --upgrade pip
pip install -r mkdocs-requirements.txt

You may have to deactivate and reactivate the venv at this point to make bash find mkdocs, even if which does find mkdocs.

Build and deploy the website, from this project's root folder:

mkdocs serve

Credits

• The old and online version is built with Sphinx using a theme provided by Read the Docs
• The newer version is built with MkDocs using the ReadTheDocs theme

Files used by continuous integration scripts

Filename	Descriptions
.lycheeignore	URLs ignored by the link checker
.spellcheck.yml	Configuration of the spell checker, use pyspelling -c .spellcheck.yml to do spellcheck locally
.wordlist.txt	Whitelisted words for the spell checker, use pyspelling -c .spellcheck.yml to do spellcheck locally

Links

• online ReStructedText table editor and generator