NCC Trainings

This is the source of the Supercomputing Luxembourg trainings.

The courses can be provided to the EVITA project. Please have a look on the EVITA project template and make sure your course format is compatible.

Setup instructions

To setup the python environment you can use uv or any compatible package manager. The compilation is tested with Pthon 3.13.5. To setup the compilation environment with uv, run in the root directory of the repository:

uv venv --python $(cat .python) ~/environments/ncc
source ~/environments/ncc/bin/activate
uv pip install --requirements requirements.txt

Deploying the page locally

The project is compiled and deployed locally with properdocs. Start by loading the development environment.

source ~/environments/ncc/bin/activate

The typeset and deploy the page with properdocs.

properdocs serve --strict

The --strict flag causes the deployment to fail in case of errors.

Compiling the images in resource directories

There is code for LaTeX generated figures in some sections. The source code is located in directories named resources. The compilation of the code requires TeX Live and the convert tool. Compile the images manually by running the command

make

inside the resource directories.

Linting

To lint the documentation locally, install in the environment the linting packages.

source ~/environments/ncc/bin/activate
uv pip install --requirements config/requirements.txt

Then, lint the markdown files with the following command.

pymarkdown \
    --config config/pymarkdown.yml --strict-config scan \
    --recurse docs

Lint the ProperDocs configuration with the following command.

yamllint --config-file config/yamllint.yml properdocs.yml