.dockerignore

@@ -0,0 +1,20 @@
+#Git files
+.git
+.git-blame-ignore-revs
+.github
+.gitignore
+build_pycarl.sh
+# The rest is based on .gitignore
+*.so
+*.py[cod]
+lib/**/_config.py
+.eggs/
+*.egg-info/
+build/
+dist/
+.idea/
+__pycache__/
+_build/
+.pytest_cache/
+.idea/
+.DS_Store

.git-blame-ignore-revs

@@ -0,0 +1 @@
+c79883ee82481451376e72b6c1dd70a03b01a676

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# Set update schedule for GitHub Actions
+
+version: 2
+updates:
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      # Check for updates to GitHub Actions every week
+      interval: "weekly"
+

.github/workflows/Dockerfile.no_parser

@@ -0,0 +1,81 @@
+# Base Dockerfile for using pycarl without building carl-parser
+###############################################################
+# The Docker image can be built by executing:
+# docker build -t yourusername/pycarl .
+# A different base image can be set from the commandline with:
+# --build-arg BASE_IMAGE=<new_base_image>
+
+# Set base image
+ARG BASE_IMAGE=movesrwth/storm-basesystem:latest
+FROM $BASE_IMAGE
+MAINTAINER Matthias Volk <m.volk@utwente.nl>
+
+
+# Configuration arguments
+#########################
+# The arguments can be set from the commandline with:
+# --build-arg <arg_name>=<value>
+
+# CMake build type
+ARG build_type=Release
+# Additional arguments for compiling pycarl
+ARG setup_args=""
+# Additional CMake arguments for carl
+ARG carl_cmake_args=""
+# Number of threads to use for parallel compilation
+ARG no_threads=2
+# Carl-storm version
+ARG carl_version=master
+
+
+# Install dependencies
+######################
+# Uncomment to update packages beforehand
+RUN apt-get update -qq
+RUN apt-get install -y --no-install-recommends \
+    python3 \
+    python3-venv
+
+
+# Build carl
+############
+WORKDIR /opt/
+
+# Obtain carl from public repository
+RUN git clone -b $carl_version https://github.com/moves-rwth/carl-storm.git carl
+
+# Switch to build directory
+RUN mkdir -p /opt/carl/build
+WORKDIR /opt/carl/build
+
+# Configure carl
+RUN cmake .. $carl_cmake_args -DCMAKE_BUILD_TYPE=$build_type
+
+# Build carl
+RUN make lib_carl -j $no_threads
+
+
+# Skip building carl-parser
+
+
+# Set-up virtual environment
+############################
+ENV VIRTUAL_ENV=/opt/venv
+RUN python3 -m venv $VIRTUAL_ENV
+ENV PATH="$VIRTUAL_ENV/bin:$PATH"
+
+RUN pip install setuptools
+
+# Build pycarl
+##############
+RUN mkdir /opt/pycarl
+WORKDIR /opt/pycarl
+
+# Copy the content of the current local pycarl repository into the Docker image
+COPY . .
+
+# Build pycarl
+RUN python setup.py build_ext $setup_args -j $no_threads develop
+
+# Uncomment to build optional dependencies
+#RUN pip install -e '.[doc]'

.github/workflows/buildtest.yml

@@ -1,4 +1,5 @@
 name: Build Test
+# Builds and tests pycarl on different Linux systems
 
 on:
   push:
@@ -7,36 +8,58 @@ on:
   schedule:
     # run weekly
     - cron: '0 10 * * 3'
+  # needed to trigger the workflow manually
   workflow_dispatch:
+  pull_request:
 
 env:
-  GIT_URL: "${{ github.server_url }}/${{ github.repository }}.git"
-  BRANCH: "master"
-  # github runners currently have two cores
-  NR_JOBS: "2"
+  # GitHub runners currently have 4 cores
+  NR_JOBS: "4"
 
-  CARL_PARSER_GIT_URL: "https://github.com/ths-rwth/carl-parser"
-  CARL_PARSER_BRANCH: "master14"
-  CARL_GIT_URL: "https://github.com/smtrat/carl"
-  CARL_BRANCH: "master14"
+jobs:
+  indepthTests:
+    name: Indepth Tests (${{ matrix.setupArgs.name }})
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        distro: ["latest"]
+        debugOrRelease: ["release"]
+        setupArgs:
+          # This is the standard config
+          #- {name: "Standard", cln: "true", parser: "true"}
+          - {name: "no CLN", cln: "false", parser: "true"}
+          - {name: "no parser", cln: "true", parser: "false"}
+          - {name: "no CLN, no parser", cln: "false", parser: "false"}
+    steps:
+      - name: Setup environment variables
+        # this is strangely the best way to implement environment variables based on the value of another
+        # GITHUB_ENV is a magic variable pointing to a file; if a line with format {NAME}={VALUE}
+        # then the env variable with name NAME will be created/updated with VALUE
+        run: |
+          ([[ ${{ matrix.debugOrRelease }} == "debug" ]] && echo "BUILD_TYPE=Debug" || echo "BUILD_TYPE=Release") >> $GITHUB_ENV
+          ([[ ${{ matrix.setupArgs.cln }} == "true" ]] && echo "CARL_CMAKE_ARGS=-DUSE_CLN_NUMBERS=ON -DUSE_GINAC=ON" || echo "CARL_CMAKE_ARGS=-DUSE_CLN_NUMBERS=OFF -DUSE_GINAC=OFF") >> $GITHUB_ENV
+          ([[ ${{ matrix.debugOrRelease }} == "debug" ]] && echo "DEBUG_SWITCH=--debug" || true) >> $GITHUB_ENV
 
-  CMAKE_DEBUG: "-DCMAKE_BUILD_TYPE=Debug"
-  CMAKE_RELEASE: "-DCMAKE_BUILD_TYPE=Release"
-  CARL_CMAKE_DEBUG: "-DCMAKE_BUILD_TYPE=Debug -DUSE_CLN_NUMBERS=ON -DUSE_GINAC=ON -DTHREAD_SAFE=ON -DBUILD_ADDONS=ON -DBUILD_ADDON_PARSER=ON"
-  CARL_CMAKE_RELEASE: "-DCMAKE_BUILD_TYPE=Release -DUSE_CLN_NUMBERS=ON -DUSE_GINAC=ON -DTHREAD_SAFE=ON -DBUILD_ADDONS=ON -DBUILD_ADDON_PARSER=ON"
+      - name: Git clone
+        uses: actions/checkout@v4
+      - name: Replace Dockerfile (optional)
+        # If carl-parser should be excluded
+        if: matrix.setupArgs.parser == 'false'
+        run: cp .github/workflows/Dockerfile.no_parser Dockerfile
+      - name: Build pycarl from Dockerfile
+        run: docker build -t movesrwth/pycarl:ci-${{ matrix.debugOrRelease }} . --build-arg BASE_IMAGE=movesrwth/storm-basesystem:${{ matrix.distro }} --build-arg build_type=${BUILD_TYPE} --build-arg carl_cmake_args="${CARL_CMAKE_ARGS}" --build-arg setup_args=${DEBUG_SWITCH} --build-arg no_threads=${NR_JOBS}
+      - name: Run Docker
+        run: docker run -d -it --name ci movesrwth/pycarl:ci-${{ matrix.debugOrRelease }}
+      - name: Run tests
+        run: docker exec ci bash -c "cd /opt/pycarl; pip install pytest; pytest"
 
-  DOCUMENTATION_DISTRO: "ubuntu-20.04"
 
-jobs:
-  noDeploy:
+  distroTests:
     name: Build and Test
     runs-on: ubuntu-latest
-    env:
-      PYTHON: "python3"
     strategy:
       matrix:
-        # exclude debian-9 as it is broken
-        distro: ["ubuntu-20.04", "ubuntu-18.04", "debian-10"]
+        distro: ["debian-12", "ubuntu-22.04", "ubuntu-24.04"]
         debugOrRelease: ["debug", "release"]
 
     steps:
@@ -45,71 +68,70 @@ jobs:
         # GITHUB_ENV is a magic variable pointing to a file; if a line with format {NAME}={VALUE}
         # then the env variable with name NAME will be created/updated with VALUE
         run: |
-          ([[ ${{ matrix.debugOrRelease }} == "debug" ]] && echo "CMAKE_ARGS=${CMAKE_DEBUG}" || echo "CMAKE_ARGS=${CMAKE_RELEASE}") >> $GITHUB_ENV
-          ([[ ${{ matrix.debugOrRelease }} == "debug" ]] && echo "CARL_CMAKE_ARGS=${CARL_CMAKE_DEBUG}" || echo "CARL_CMAKE_ARGS=${CARL_CMAKE_RELEASE}") >> $GITHUB_ENV
+          ([[ ${{ matrix.debugOrRelease }} == "debug" ]] && echo "BUILD_TYPE=Debug" || echo "BUILD_TYPE=Release") >> $GITHUB_ENV
           ([[ ${{ matrix.debugOrRelease }} == "debug" ]] && echo "DEBUG_SWITCH=--debug" || true) >> $GITHUB_ENV
-      - name: Init Docker
-        run: sudo docker run -d -it --name ci --privileged movesrwth/storm-basesystem:${{ matrix.distro }}
-        # We should not do partial updates :/
-        # but we need to install some dependencies
-        # Surely we can find a better way to do this at some point
-      - name: Update base system
-        run: |
-          sudo docker exec ci apt-get update
-          sudo docker exec ci apt-get upgrade -qqy
-      - name: install dependencies
-        run: sudo docker exec ci apt-get install -qq -y maven uuid-dev libeigen3-dev python3 python3-venv
-      - name: Git clone
-        run: |
-          sudo docker exec ci git clone --depth 1 --branch $BRANCH $GIT_URL /opt/pycarl
-          sudo docker exec ci git clone --depth 1 --branch $CARL_BRANCH $CARL_GIT_URL /opt/carl
-          sudo docker exec ci git clone --depth 1 --branch $CARL_PARSER_BRANCH $CARL_PARSER_GIT_URL /opt/carl-parser
 
-      - name: Run cmake for carl
-        run: sudo docker exec ci bash -c "mkdir /opt/carl/build; cd /opt/carl/build; cmake .. ${CARL_CMAKE_ARGS}"
-      - name: Build carl
-        run: sudo docker exec ci bash -c "cd /opt/carl/build; make lib_carl -j ${NR_JOBS}"
+      - name: Git clone
+        uses: actions/checkout@v4
+      - name: Build pycarl from Dockerfile
+        run: docker build -t movesrwth/pycarl:ci-${{ matrix.debugOrRelease }} . --build-arg BASE_IMAGE=movesrwth/storm-basesystem:${{ matrix.distro }} --build-arg build_type=${BUILD_TYPE} --build-arg setup_args=${DEBUG_SWITCH} --build-arg no_threads=${NR_JOBS}
+      - name: Run Docker
+        run: docker run -d -it --name ci movesrwth/pycarl:ci-${{ matrix.debugOrRelease }}
+      - name: Run tests
+        run: docker exec ci bash -c "cd /opt/pycarl; pip install pytest; pytest"
 
-      - name: Run cmake for carl-parser
-        run: sudo docker exec ci bash -c "mkdir /opt/carl-parser/build; cd /opt/carl-parser/build; cmake .. ${CMAKE_ARGS}"
-      - name: make carl-parser
-        run: sudo docker exec ci bash -c "cd /opt/carl-parser/build; make -j ${NR_JOBS}"
+  deploy:
+    name: Build, Test and deploy documentation
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        debugOrRelease: ["debug", "release"]
 
-      - name: Setup virtualenv
-        run: |
-          sudo docker exec ci bash -c "cd /opt; ${PYTHON} -m venv pycarl-env; source pycarl-env/bin/activate; python --version"
-      - name: Build pycarl
+    steps:
+      - name: Setup environment variables
+        # this is strangely the best way to implement environment variables based on the value of another
+        # GITHUB_ENV is a magic variable pointing to a file; if a line with format {NAME}={VALUE}
+        # then the env variable with name NAME will be created/updated with VALUE
         run: |
-          sudo docker exec ci bash -c "cd /opt; source pycarl-env/bin/activate; cd /opt/pycarl; python setup.py build_ext $DEBUG_SWITCH -j ${NR_JOBS} develop"
+          ([[ ${{ matrix.debugOrRelease }} == "debug" ]] && echo "BUILD_TYPE=Debug" || echo "BUILD_TYPE=Release") >> $GITHUB_ENV
+          ([[ ${{ matrix.debugOrRelease }} == "debug" ]] && echo "DEBUG_SWITCH=--debug" || true) >> $GITHUB_ENV
+
+      - name: Git clone
+        uses: actions/checkout@v4
+      - name: Build pycarl from Dockerfile
+        run: docker build -t movesrwth/pycarl:ci-${{ matrix.debugOrRelease }} . --build-arg BASE_IMAGE=movesrwth/storm-basesystem:latest --build-arg build_type=${BUILD_TYPE} --build-arg setup_args=${DEBUG_SWITCH} --build-arg no_threads=${NR_JOBS}
+      - name: Run Docker
+        run: docker run -d -it --name ci movesrwth/pycarl:ci-${{ matrix.debugOrRelease }}
       - name: Run tests
-        run: |
-          sudo docker exec ci bash -c "cd /opt; source pycarl-env/bin/activate; cd /opt/pycarl; python setup.py test"
+        run: docker exec ci bash -c "cd /opt/pycarl; pip install pytest; pytest"
 
-        # build and publish documentation
+        # Build and publish documentation for release build
       - name: Install documentation dependencies
-        if: matrix.debugOrRelease == 'release' && matrix.distro == env.DOCUMENTATION_DISTRO
-        run: sudo docker exec ci bash -c "cd /opt; source pycarl-env/bin/activate; cd pycarl; pip install sphinx sphinx_bootstrap_theme"
+        if: matrix.debugOrRelease == 'release'
+        run: docker exec ci bash -c "cd /opt/pycarl; pip install -e '.[doc]'"
       - name: Build documentation
-        if: matrix.debugOrRelease == 'release' && matrix.distro == env.DOCUMENTATION_DISTRO
+        if: matrix.debugOrRelease == 'release'
         run: |
-          sudo docker exec ci bash -c "cd /opt; source pycarl-env/bin/activate; cd pycarl/doc; make html"
-          sudo docker exec ci rm -r /opt/pycarl/doc/build/html/_sources
-          sudo docker cp ci:/opt/pycarl/doc/build/html .
+          docker exec ci bash -c "cd /opt/pycarl/doc; make html"
+          docker exec ci rm -r /opt/pycarl/doc/build/html/_sources
+          docker cp ci:/opt/pycarl/doc/build/html .
       - name: Deploy documentation
-        if: matrix.debugOrRelease == 'release' && matrix.distro == env.DOCUMENTATION_DISTRO
-        uses: peaceiris/actions-gh-pages@v3
+        # Only deploy for master on original repo (and not for pull requests or forks)
+        if: matrix.debugOrRelease == 'release' && github.repository_owner == 'moves-rwth' && github.ref == 'refs/heads/master'
+        uses: peaceiris/actions-gh-pages@v4
         with:
           personal_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./html
 
   notify:
     name: Email notification
     runs-on: ubuntu-latest
-    needs: [noDeploy]
-    if: always() # set always
+    needs: [indepthTests,distroTests,deploy]
+    # Only run in main repo and even if previous step failed
+    if: github.repository_owner == 'moves-rwth' && always()
     steps:
-      - uses: technote-space/workflow-conclusion-action@v2
-      - uses: dawidd6/action-send-mail@v2
+      - uses: technote-space/workflow-conclusion-action@v3
+      - uses: dawidd6/action-send-mail@v4
         with:
           server_address: ${{ secrets.STORM_CI_MAIL_SERVER }}
           server_port: 587

.github/workflows/formatapply.yml

@@ -0,0 +1,38 @@
+name: apply-code-format
+
+on: [ workflow_dispatch ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: psf/black@stable
+        with:
+          options: ""
+          src: "."
+          jupyter: true
+      - name: Commit Formatting
+        run: |
+          git config user.name 'Auto Format'
+          git config user.email 'dev@stormchecker.org'
+          if [ -z "$(git status --porcelain)" ]
+          then
+          echo "Code did not change"
+          else
+          git commit -am "Applied code formatting"
+          git rev-parse HEAD >> .git-blame-ignore-revs
+          git commit -am "Add code formatting commit to .git-blame-ignore-revs"
+          fi
+      - name: Create Pull Request
+        id: cpr
+        uses: peter-evans/create-pull-request@v7
+        with:
+          branch: ci/apply-code-format
+          delete-branch: true
+          title: 'Code formatting'
+          body: |
+            Auto-generated pull request triggered by the `apply-code-format` workflow.
+            - Manually close and reopen this PR to trigger the CI.
+            - Make sure to **merge** (and not rebase) this PR so that the added commit hash in `.git-blame-ignore-revs` remains valid.

.github/workflows/formatcheck.yml

@@ -0,0 +1,15 @@
+name: check-code-format
+
+on: [push, pull_request, workflow_dispatch]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - uses: psf/black@stable
+      with:
+        options: "--check --diff --color"
+        src: "."
+        jupyter: true