Table of Contents

• Table of Contents
  • About this tutorial
  • Goal of this tutorial
  • How to run it?
    • BinderHub
    • Local installation
      • On Windows
      • On macOS
    • Docker
  • For maintainers and contributors

About this tutorial

This tutorial is heavily inspired from a C++ tutorial created by David Chamont (CNRS) that was given as a lecture with the help of Vincent Rouvreau (Inria) in 2016; latest version of this tutorial used as the basis of current one may be found there.

Current version provides two major modifications:

• The tutorial is now in english.
• Jupyter notebooks using Xeus-cling kernel are now used, thus enabling a sort of interpreted C++ which is rather helpful for teaching it (even if it is clearly not yet mature...)

I have rewritten entirely and modified heavily several chapters, but the backbone remains heavily indebted to David and Vincent and the hands-on is still very similar to the original one.

As the original tutorial, the present lecture is released under the Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0) licence.

Goal of this tutorial

This is an introductory lecture to the modern way of programming C++; at the end of it you should:

• Understand the syntax and basic mechanisms of the C++ language in version 14/17.
• Know the different programming styles.
• Know of and be able to use the most useful part of the standard library.
• Be aware of many good programming practices in C++.

How to run it?

You may run the notebooks by one of the three following methods:

• From your browser through a Binder instance.
• Directly on your computer system.
• Through a Docker image on your computer.

Quick guides for each of these methods are given below.

BinderHub

A link to a BinderHub instance is given at the top of the project page; foresee few minutes to set up properly the notebooks.

The pro of using Binder is that you have basically nothing more to do than click on the link; the cons are the delay to create the instance, the need for an Internet connection and the fact you won't keep locally the possible modifications you did.

Local installation

As this tutorial relies heavily on Xeus-cling kernel, the only requirement is to install this environment on your machine.

It can be done easily (at least on Linux - see below for Windows and macOS) through:

Should the procedure described below not work at some point I invite you to check the link above, but at the time of this writing you need to:

• Install miniconda3 environment (apparently using full-fledged anaconda may lead to conflict in dependencies).
• Create a new conda environment and activate it:

conda env create -f environment.yml
conda activate training_cpp

Don't forget to activate it each time you intend to run the lecture!

• Then you can run the notebook by going into its root directory (or internal links won't work...) in a terminal and typing:

jupyter lab

NOTE: It is possible to use the notebooks directly from some IDEs like VSCode.

On Windows

No package is provided for Windows for Xeus-cling package (https://github.com/jupyter-xeus/xeus-cling).

Your best option if you're using Windows 10 or 11 is probably to install Ubuntu in your Windows session; I haven't tried this myself.

On macOS

Since at least May 2021, Conda packaging is broken for macOS (11.3). A ticket has been issued but to no avail so far despite several users chiming in or opening similar tickets.

Situation is even more dire for ARM computers. The best for macOS user is probably to use Binder or Docker.

Docker

It is possible to execute the notebooks in a Docker container.

First get the image from Gitlab registry:

docker login registry.gitlab.inria.fr
docker pull registry.gitlab.inria.fr/formations/cpp/gettingstartedwithmoderncpp/xeus-cling:latest

Then run a container with:

docker run --rm -e JUPYTER_TOKEN='easy' -p 8888:8888  --cap-drop=all -v $PWD:/home/dev_cpp/training_cpp  registry.gitlab.inria.fr/formations/cpp/gettingstartedwithmoderncpp/xeus-cling:latest

And in your browser type http://localhost:8888

and then type easy in the token dialog box (of course you may replace by whatever you want).

Few hints for those not familiar with Docker:

• -v creates a mapping between local folder and the /home/dev_cpp/training_cpp folder in the container; this enables you to edit the file from your comfy local environment and see the file edited this way in the Docker container.
• --cap-drop=all is a safety when you're running a Docker image not built by yourself: you're essentially blocking the few remaining operations that might impact your own environment that Docker lets by default open with the run command.
• -p gives the port mapping between the Docker image and your local environment.
• --rm tells docker to delete the container after its use.

The lengthy registry.gitlab.inria.fr/formations/cpp/gettingstartedwithmoderncpp/xeus-cling-and-compilers is the name of the Docker image, if this image is not present locally in your environment Docker will try to fetch it from a registry on the Inria Gitlab.

Then just type http://localhost:8888/ in your browser to run the notebooks.

For maintainers and contributors

Information related to CI are here. All contributions are welcome, but please read the contribution guide first.