Scientific Computing

CMake can use the GitHub REST API to fetch the latest release download URL from GitHub in the form of JSON data. The API is useful to download the latest release of a GitHub project using CMake. The API used in this example specifically ignore pre-releases and draft releases. The example CMake code shows how to parse the JSON data to get the download URL.

CMake file(DOWNLOAD …) has HTTPHEADER option that can be repeated to add multiple headers to the HTTP request. In GitHubRelease.cmake linked above, a specific version of the GitHub API and format is used to get the latest release download URL. Authentication parameters can also be passed if API limits are exceeded. Don’t save/commit API credentials to a public repository!

file(DOWNLOAD ...
HTTPHEADER "Accept: application/vnd.github+json"
HTTPHEADER "X-GitHub-Api-Version: 2022-11-28"
)

Matlab requires compatible compilers to run compiled code and even to run itself. Trying to use Matlab on a non-supported just-released OS version can sometimes encounter difficulty. libc, libstdc++, or libgfortran incompatible with Matlab and cause failure to run MEX code. The workaround below assumes Linux.

Example error messages:

MATLAB/R*/sys/os/glnxa64/libstdc++.so.6: version `GLIBCXX_3.4.29’ not found (myfun.mexa64)

Workaround by having the system libraries take priority by using environment variable LD_PRELOAD.

Find the system libstdc++:

find /usr -name libstdc++.so.6

Suppose “/usr/lib64/libstdc++.so.6”.

LD_PRELOAD=/usr/lib64/libstdc++.so.6 matlab

In certain cases, such as defining multiple classes or templates in a single header or source file in C or C++, it may be useful to include inline source code files to reduce code duplication. This can be achieved by using the #include directive with a file containing the inline code. This technique is distinct from the use of header files, which are typically used to declare functions, classes, and other entities that are defined in a separate source file. This technique is also distinct from the use of the inline specifier on functions.

A traditional file suffix for include code files is .inc or .inl, but any suffix can be used. Build systems detect changes to these included inline code files and rebuild the source file if necessary. For example, CMake detects include dependencies (header, inline code) based on its own source parser, or some modern compilers manage dependencies themselves.

Makefiles with CMake uses the compiler itself or depend.make in each target build directory to track dependencies.

Ninja (with CMake or other build system such as Meson) specifies include dependencies via depfiles per source file, which may be observed for debugging with option ninja -d keepdepfile

Example

Here we assume a CMake project with source file main.cpp and inline source file myconst.inl.

main.cpp:

#include <iostream>
#include "myconst.inl"

int main() {
    std::cout << "The value of MY_CONST is: " << MY_CONST << "\n";
    return 0;
}

myconst.inl:

constexpr int MY_CONST 42

cmake_minimum_required(VERSION 3.20)

project(InlineDemo LANGUAGES C CXX)

add_executable(demo main.cpp)

Observe that CMake will rebuild main.cpp if myconst.inl changes.

cmake -Bbuild
cmake --build build

touch myconst.inl

cmake --build build

The Fortran include statement inserts source code from the specified file into the Fortran source code file at the location of the include statement. The include file can contain any valid Fortran syntax, including procedures, modules, variable definitions, operations, etc. This concept is similar to the C/C++ #include preprocessor directive that can also be used for inlining code, but Fortran include does not require a preprocessor. include statements are frequently used to reuse code like defining constants or Fortran 77 common blocks. Generated code from build systems like CMake and Meson can be consumed with include statements. The file suffix “.inc” is often used, but is arbitrary.

One example of a Fortran-only project extensively using CMake-generated Fortran source with include is h5fortran to allow polymorphic (type and rank) HDF5 I/O in Fortran. The source code deduplication thus achieved is significant and the code is easier to maintain.

Build systems scan Fortran source files for dependencies to detect the include statements and track the included files. Makefiles with CMake uses the compiler itself or depend.make in each target build directory to track dependencies. Ninja (with CMake or other build system such as Meson) specifies include dependencies via depfiles per source file, which may be observed for debugging with option ninja -d keepdepfile

In the example below, the dependency of main.f90 on const.inc is tracked by:

• Ninja: depfile “build/CMakeFiles/main.dir/main.f90-pp.f90.d”
• Make: “build/CMakeFiles/main.dir/depend.make”

A minimal example of using the Fortran include statement is shown below.

main.f90:

program main

include 'const.inc'

print '(A, I0)', 'The value of my_const is: ', my_const

end program

const.inc:

integer, parameter :: my_const = 42

CMakeLists.txt:

cmake_minimum_required(VERSION 3.20)

project(include_example LANGUAGES Fortran)

add_executable(main main.f90)

Observe that CMake will rebuild main.f90 if const.inc changes.

cmake -Bbuild
cmake --build build

touch const.inc

cmake --build build

If importing Python modules or trying to run an Anaconda Python program like Spyder gives CXXABI errors, it can be due to a conflict between the system libstdc++ and the Anaconda libstdc++. Assuming Anaconda / Miniconda Python on Linux, try specifying the libstdc++ library in the conda environment by LD_PRELOAD.

Find the system libstdc++:

find /usr -name libstdc++.so.6

Suppose “/usr/lib64/libstdc++.so.6”. Set LD_PRELOAD environment variable in the conda environment:

conda env config vars set LD_PRELOAD=/usr/lib64/libstdc++.so.6

conda activate

Then retry the command / program.

Matlab Online and locally-installed Matlab Desktop can use “dark mode” for the Matlab Desktop.

s = settings;

s.matlab.appearance.MATLABTheme.PersonalValue = "Dark";

Or from the GUI by searching for “Dark” in the Matlab settings.

Figures can be switched between light and dark mode with theme().

Related: Alternative Matlab code editors

References:

• dark theme discussion
• R2024a dark mode superseded by later releases.

Matlab codeIssues() command recursively lints Matlab .m code files. The output is a neat table.

The Matlab build system has a built-in CodeIssuesTask for use via buildtool to validate an entire Matlab project from a single command.

Used from CI, this is a quick first step check of a project to help ensure compatibility of code syntax across Matlab versions. Of course, the Matlab version checked is only the currently-running Matlab, so the CI system would need to fan out running across the desired Matlab versions.

Matlab Git operations are a first-class part of the Matlab environment, without need for system() calls. The Matlab Desktop GUI or Matlab factory functions allow most common Git operations to be directly performed.

For example, Git clone is a plain Matlab function that can be called from the command line or script.

gitclone("https://github.invalid/username/repo.git")

The Matlab branching and merging GUI can be helpful for those not familiar with Git commands.

Some Git Matlab operations are object-oriented, for example Git pull

repo = gitrepo("https://github.invalid/username/repo.git");

pull(repo)

Determine PowerShell window height and width with these commands:

$Host.UI.RawUI.WindowSize.Width

$Host.UI.RawUI.WindowSize.Height

For research reproducibility, a Docker image gives a known software state that should be usable for many years. It isn’t strictly necessary to make a custom image as described below, but it can be useful for a known software state.

Create a Docker image by using a Dockerfile. If desired to set environment variables, use ENV Dockerfile instruction.

FROM alpine:latest

# example for CMake project using Fortran with OpenMPI.
RUN apk add --no-cache ninja-build cmake gfortran openmpi-dev

ENV CMAKE_GENERATOR=Ninja

Create the file above named Dockerfile in the Git repo.

apk

Alpine package manager

Build the Docker image:

docker build -t openmpi-fortran .

from the same directory as Dockerfile

Check the image exists–it may be nearly 500 MB:

docker images

Before committing for upload, invoke the container.

docker run openmpi-fortran

This will almost immediately start and stop, as it didn’t have a command to run or persist.

Get the hexadecimal container ID by:

docker ps -a

The container will have an auto-assigned name. Note the hexadecimal “Container ID”.

upload Docker image

Once the configured Docker container is ready, share this container. This can be done with Docker Hub.

Once ready to upload the image, note the “container ID”, which is the hexadecimal number at the terminal prompt of the Docker container, under docker ps. The container hex ID must appear under docker ps, just being in docker images is not enough.

docker commit -m "Fortran Dockerfile setup" hex_id dockerhub_username/openmpi-fortran

The changes to the image the container made are gathered into a new image. It may take a minute or two for a large image. Ideally with a small image it will take only a couple seconds. The new image has not yet left the computer, it will show up under

docker images

Once uploaded, the Docker image is visible to the world by default.

Login to Docker Hub

docker login -u dockerhub_username

Push (upload) this image to Docker Hub. This image is world-visible by default!

docker push dockerhub_username/openmpi-fortran

If the image is very large > 1 GB, be aware it will take a while to upload, and for the host to download. This is a telltale that it’s important to keep Docker images small.