Add scaffolding for python wrappers and SBML

.flake8

@@ -0,0 +1,13 @@
+[flake8]
+max_line_length = 120
+
+exclude =
+    __pycache__,
+    .git,
+    .github,
+    .venv,
+    .virtualenv,
+    build,
+    output,
+    venv,
+    virtualenv,

.github/workflows/test-project.yml

@@ -0,0 +1,50 @@
+name: Test Project
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["**"]
+
+concurrency:
+  group: test-project-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test-project:
+    runs-on: ubuntu-latest
+
+    container:
+      image: chaste/base
+      options: --user root
+
+    env:
+      CHASTE_SOURCE_DIR: /tmp/Chaste
+      CHASTE_BUILD_DIR: /tmp/build
+      CHASTE_TEST_OUTPUT: /tmp/testoutput
+      PROJECT_DIR: /tmp/myproject
+
+    steps:
+      - name: Checkout template
+        uses: actions/checkout@v7
+
+      - name: Checkout Chaste source
+        run: |
+          git clone --depth 1 --branch develop https://github.com/Chaste/Chaste.git "${CHASTE_SOURCE_DIR}"
+          git config --global --add safe.directory "${CHASTE_SOURCE_DIR}"
+
+      - name: Create test project
+        run: |
+          cp -r . ${{ env.PROJECT_DIR }}
+          cd ${{ env.PROJECT_DIR }}
+          # Prompt defaults (no components, no Python bindings, no SBML), yes to confirm
+          printf '\n\n\n\n\nn\nn\ny\n' | python3 setup_project.py
+
+      - name: Configure
+        run: ${{ env.PROJECT_DIR }}/scripts/configure.sh
+
+      - name: Compile
+        run: ${{ env.PROJECT_DIR }}/scripts/compile.sh
+
+      - name: Test
+        run: ${{ env.PROJECT_DIR }}/scripts/test.sh

.github/workflows/test-python-project.yml

@@ -0,0 +1,98 @@
+name: Test Python Project
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["**"]
+
+concurrency:
+  group: test-python-project-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test-python-project:
+    # Two configurations:
+    #  - default-components: the python wrapper template exactly as shipped.
+    #  - force-example: the bindings/example walkthrough.
+    name: ${{ matrix.variant }}
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          # Prompt defaults (proceed, no optional components), yes to Python
+          # bindings, no to SBML, yes to confirm
+          - variant: default-components
+            answers: '\n\n\n\n\ny\nn\ny\n'
+          # Yes to proceed, yes to cell_based, no to crypt/heart/lung, yes to
+          # Python bindings, no to SBML, yes to confirm
+          - variant: force-example
+            answers: 'y\ny\nn\nn\nn\ny\nn\ny\n'
+
+    container:
+      image: chaste/base
+      options: --user root
+
+    env:
+      CHASTE_SOURCE_DIR: /tmp/Chaste
+      CHASTE_BUILD_DIR: /tmp/build
+      CHASTE_TEST_OUTPUT: /tmp/testoutput
+      PROJECT_DIR: /tmp/myproject
+
+    steps:
+      - name: Checkout template
+        uses: actions/checkout@v7
+
+      - name: Checkout Chaste source
+        run: |
+          git clone --depth 1 --branch develop https://github.com/Chaste/Chaste.git "${CHASTE_SOURCE_DIR}"
+          git config --global --add safe.directory "${CHASTE_SOURCE_DIR}"
+
+      - name: Create test project
+        run: |
+          cp -r . ${{ env.PROJECT_DIR }}
+          cd ${{ env.PROJECT_DIR }}
+          printf '%b' '${{ matrix.answers }}' | python3 setup_project.py
+
+      - name: Add MyForce to the project bindings
+        if: matrix.variant == 'force-example'
+        run: |
+          cd ${{ env.PROJECT_DIR }}
+          cp bindings/example/MyForce.hpp bindings/example/MyForce.cpp src/
+          sed -i.bak 's/^    classes:$/&\n      - name: MyForce/' bindings/config.yaml
+          # Import PyChaste's module and declare AbstractForce as an external base
+          sed -i.bak 's/^  - name: all$/&\n    imports:/' bindings/config.yaml
+          sed -i.bak 's/^    imports:$/&\n      - chaste._pychaste_all/' bindings/config.yaml
+          sed -i.bak 's/^      - chaste._pychaste_all$/&\n    external_bases:/' bindings/config.yaml
+          sed -i.bak 's/^    external_bases:$/&\n      - AbstractForce/' bindings/config.yaml
+          # The seds above anchor on the shipped formatting of config.yaml; fail loudly
+          # here rather than later with a confusing "MyForce_2 not found" at runtime.
+          grep -q '^      - name: MyForce$' bindings/config.yaml
+          grep -q '^      - chaste._pychaste_all$' bindings/config.yaml
+          grep -q '^      - AbstractForce$' bindings/config.yaml
+
+      - name: Configure
+        run: ${{ env.PROJECT_DIR }}/scripts/configure.sh
+
+      - name: Compile
+        run: ${{ env.PROJECT_DIR }}/scripts/compile.sh
+
+      - name: Install
+        run: ${{ env.PROJECT_DIR }}/bindings/install.sh
+
+      - name: Test Python bindings
+        run: |
+          ${{ env.PROJECT_DIR }}/.virtualenv/bin/python -c "
+          import myproject
+          h = myproject.Hello_myproject('Hello from Python!')
+          message = h.GetMessage()
+          assert message == 'Hello from Python!', f'Expected \"Hello from Python!\" but got \"{message}\"'
+          print(f'GetMessage() returned: {message}')
+          print('Test passed!')
+          "
+
+      - name: Run the MyForce simulation from Python
+        if: matrix.variant == 'force-example'
+        run: ${{ env.PROJECT_DIR }}/.virtualenv/bin/python ${{ env.PROJECT_DIR }}/bindings/example/run_my_force.py

.github/workflows/test-sbml-project.yml

@@ -0,0 +1,64 @@
+name: Test SBML Project
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["**"]
+
+concurrency:
+  group: test-sbml-project-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test-sbml-project:
+    runs-on: ubuntu-latest
+
+    container:
+      image: chaste/base
+      options: --user root
+
+    env:
+      CHASTE_SOURCE_DIR: /tmp/Chaste
+      CHASTE_BUILD_DIR: /tmp/build
+      CHASTE_TEST_OUTPUT: /tmp/testoutput
+      PROJECT_DIR: /tmp/myproject
+
+    steps:
+      - name: Checkout template
+        uses: actions/checkout@v7
+
+      - name: Checkout Chaste source
+        run: |
+          git clone --depth 1 --branch develop https://github.com/Chaste/Chaste.git "${CHASTE_SOURCE_DIR}"
+          git config --global --add safe.directory "${CHASTE_SOURCE_DIR}"
+
+      - name: Install clang-format
+        run: apt-get update && apt-get install -y clang-format
+
+      - name: Create test project
+        run: |
+          cp -r . ${{ env.PROJECT_DIR }}
+          cd ${{ env.PROJECT_DIR }}
+          # Prompt defaults for proceed/components/no-python-bindings, yes to SBML, yes to confirm
+          printf '\n\n\n\n\n\ny\ny\n' | python3 setup_project.py
+
+      - name: Install chaste-sbml
+        run: ${{ env.PROJECT_DIR }}/sbml/install.sh
+
+      - name: Import the Goldbeter 1991 model
+        run: |
+          cd ${{ env.PROJECT_DIR }}
+          cp sbml/example/Goldbeter1991.xml .
+          .virtualenv/bin/chaste-sbml Goldbeter1991.xml --model-type srn --output-dir src/
+          cp sbml/example/TestGoldbeter1991SbmlSrnModel.hpp test/
+          echo "TestGoldbeter1991SbmlSrnModel.hpp" >> test/ContinuousTestPack.txt
+
+      - name: Configure
+        run: ${{ env.PROJECT_DIR }}/scripts/configure.sh
+
+      - name: Compile
+        run: ${{ env.PROJECT_DIR }}/scripts/compile.sh
+
+      - name: Test
+        run: ${{ env.PROJECT_DIR }}/scripts/test.sh

.gitignore

@@ -1,2 +1,42 @@
 build/
+output/
 
+.vscode/
+
+.DS_Store
+Thumbs.db
+
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+.virtualenv/
+.venv/
+venv/
+env/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+
+# C++
+*.o
+*.obj
+*.lo
+*.slo
+*.a
+*.lib
+*.so
+*.dylib
+*.dll
+*.exe
+*.out
+*.gch
+*.pch
+
+# CMake
+CMakeCache.txt
+CMakeFiles/
+cmake_install.cmake
+CTestTestfile.cmake
+compile_commands.json

CMakeLists.txt

@@ -1,4 +1,4 @@
-# Copyright (c) 2005-2023, University of Oxford.
+# Copyright (c) 2005-2026, University of Oxford.
 # All rights reserved.
 # 
 # University of Oxford means the Chancellor, Masters and Scholars of the
@@ -52,3 +52,7 @@ find_package(Chaste COMPONENTS continuum_mechanics global io linalg mesh ode pde
 # Change the project name in the line below to match the folder this file is in,
 # i.e. the name of your project.
 chaste_do_project(template_project)
+
+if(Chaste_ENABLE_PYCHASTE AND EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/bindings")
+    add_subdirectory(bindings)
+endif()

README.md

@@ -6,4 +6,29 @@ Alternatively, if you aren't a github user, you can download a zip (see Releases
 
 Then see the [User Projects](https://chaste.github.io/docs/user-guides/user-projects/) guide page on the Chaste website for more information.
 
-If you clone this repository, you should make sure to rename the template_project folder with your project name and run the 'setup_project.py' script to avoid conflicts if you have multiple projects.
+If you clone this repository, you should make sure to rename the **template_project** folder with your project name and run the `setup_project.py` script to avoid conflicts if you have multiple projects.
+
+## What's in here
+
+| Path | |
+| --- | --- |
+| `src/`, `test/`, `apps/` | your project's C++ code; only `src/` is compiled into the project library |
+| `scripts/` | configure / compile / test helpers |
+| `bindings/` | optional PyChaste Python bindings; see [bindings/README.md](bindings/README.md) |
+| `sbml/` | optional SBML model import; see [sbml/README.md](sbml/README.md) |
+
+`setup_project.py` asks whether you want each optional capability and removes the
+directory if you decline, so a plain C++ project keeps neither.
+
+## Building
+
+There are simple convenience scripts available to help with the build process. From the project directory, with `CHASTE_SOURCE_DIR` pointing at your Chaste source:
+
+```sh
+scripts/configure.sh   # symlink the project into Chaste/projects and configure the build
+scripts/compile.sh     # build the project
+scripts/test.sh        # run the project's tests
+```
+
+If you need more detailed control of the build process, see the
+[full Chaste build guide](https://chaste.github.io/docs/dev-guides/cmake-build-guide/).