Deployed at:
http://github-pages.ucl.ac.uk/research-computing-with-cpp
Clone and build the various output files (that step will need some dependencies)
git clone https://github.com/UCL-RITS/research-computing-with-cpp
cd research-computing-with-cpp
./build.sh
Then you can proceed to build the website locally. The easiest is via docker.
mkdir ../bundle # To don't download every single time the ruby dependencies
docker run --rm --volume="$PWD:/srv/jekyll" --volume="$PWD/../bundle:/usr/local/bundle" -it jekyll/jekyll:4 jekyll build
python -m http.server -d _site
All the dependencies are set in the .github/{texlive,python}/requirements.txt
for an ubuntu machine.
On a Mac, we use g++ installed via homebrew. So, for g++ version 7, we would run the build command as:
CC=gcc-7 CXX=g++-7 ./build.sh
The explicit compiler selection is needed on Mac OS for OpenMP (and possibly MPI) examples to build. Update the version number as necessary.
You will need to have a bunch of stuff installed in order for the build to succeed. For Mac:
brew install boost
brew install open-mpi
brew install gcc
brew install ruby
gem install jekyll --version '~> 4'
gem install jekyll-remote-theme
`brew install wget
matplotlib
(plus several other scientific python libraries)A full LaTeX distribution needs to be available to generate a PDF version of the course notes by the build script.
Alternatively, you can build the docker container available and build the site through it:
$ docker build -t rcpp
$ docker run -it --rm --volume=$PWD:/root rcpp:latest bash
# cd
# ITK_DIR=/usr/lib/InsightToolkit ./build.sh
# make _site
Then in folder _site, you'll have the html
's.
Or, for a shortcut: make preview
See https://github.com/UCL-RITS/research-computing-with-cpp/blob/master/01cpp/index.md for an example of how to reference a C file, CMake file, and run an executable
And https://github.com/UCL-RITS/research-computing-with-cpp/tree/master/01cpp/cpp/hello for the corresponding code