ScrollPrize · stephenrparsons · Sep 8, 2025 · Sep 5, 2025 · Sep 5, 2025 · Sep 5, 2025
@@ -1,13 +1,19 @@
-name: Continous Integration (CI)
+name: Continuous Integration (CI)
 
 on:
   pull_request:
-  workflow_dispatch:
+    paths:
+      - 'volume-cartographer/**'
+      - '.github/workflows/vc3d-ci.yml'
 
 jobs:
   docker:
     name: Build Docker Image
     runs-on: ubuntu-24.04
+    defaults:
+      run:
+        working-directory: ./volume-cartographer
+
     steps:
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
@@ -18,6 +24,7 @@ jobs:
       - name: Build and push
         uses: docker/build-push-action@v6
         with:
+            context: "{{defaultContext}}:volume-cartographer"
             file: ubuntu-24.04-noble.Dockerfile
             push: false
-            tags: ${{ github.repository_owner }}/volume-cartographer:latest
+            tags: ${{ github.repository_owner }}/volume-cartographer:latest
@@ -2,7 +2,9 @@ name: "CodeQL"
 
 on:
   pull_request:
-  workflow_dispatch:
+    paths:
+      - 'volume-cartographer/**'
+      - '.github/workflows/vc3d-codeql.yml'
   schedule:
     # Friday 11:43 UTC
     - cron: '43 11 * * 5'
@@ -21,6 +23,10 @@ jobs:
       security-events: write
       # required to fetch internal or private CodeQL packs
       packages: read
+    defaults:
+      run:
+        working-directory: ./volume-cartographer
+
 
     steps:
       - name: Checkout repository

@@ -2,8 +2,10 @@ name: Build & Push Docker Image (ghcr.io)
 
 on:
   push:
-    branches: ["dev-next", "latest"]
-  workflow_dispatch:
+    branches: ["main", "latest"]
+    paths:
+      - 'volume-cartographer/**'
+      - '.github/workflows/vc3d-publish-ghcr.yml'
 
 concurrency: docker
 
@@ -63,6 +65,7 @@ jobs:
         id: build
         uses: docker/build-push-action@v6
         with:
+          context: "{{defaultContext}}:volume-cartographer"
           file: ubuntu-24.04-noble.Dockerfile
           platforms: linux/amd64
           labels: ${{ steps.meta.outputs.labels }}
@@ -124,6 +127,7 @@ jobs:
         id: build
         uses: docker/build-push-action@v6
         with:
+          context: "{{defaultContext}}:volume-cartographer"
           file: ubuntu-24.04-noble.Dockerfile
           platforms: linux/arm64
           labels: ${{ steps.meta.outputs.labels }}

@@ -39,10 +39,10 @@ Originally developed by [Youssef Nader](https://github.com/younader) and [Luke F
 
 ## Automatic Unwrapping (Segmentation) Pipelines
 
-### [VC3D (surface tracer)](https://github.com/ScrollPrize/volume-cartographer)
+### [VC3D (surface tracer)](volume-cartographer)
 A semi-automatic segmentation pipeline to extract papyrus sheets from CT scans of ancient scrolls.
-As of July 2025, it is the approach currently used by the official team, and it is contained in an another repository.
-Developed by [Hendrik Schilling](https://github.com/hendrikschilling) and [Sean Johnson](https://github.com/bruniss) as a fork of Volume Cartographer.
+As of September 2025, it is the approach used by the Vesuvius Challenge team.
+Developed by [Hendrik Schilling](https://github.com/hendrikschilling) and [Sean Johnson](https://github.com/bruniss) as a fork of [Volume Cartographer](https://github.com/educelab/volume-cartographer).
 
 ### [spiral fitting](https://github.com/pmh47/spiral-fitting)
 A fully automatic unwrapping pipeline that fits a spiral to the CT scan.

@@ -71,7 +71,7 @@ This page lists all the prizes awarded so far:
 **Announcement:** <a href="https://scrollprize.substack.com/p/may-progress-prizes-and-updates-to">Blog post</a>
 
 <div className="flex flex-row flex-wrap">
-  <a className="max-w-[200px] mr-4 mb-4 text-gray-100 bg-[#444] hover:bg-[#555] hover:text-[unset] p-4 rounded-lg flex flex-col justify-between" href="https://github.com/ScrollPrize/volume-cartographer">
+  <a className="max-w-[200px] mr-4 mb-4 text-gray-100 bg-[#444] hover:bg-[#555] hover:text-[unset] p-4 rounded-lg flex flex-col justify-between" href="https://github.com/ScrollPrize/villa/tree/main/volume-cartographer">
     <div className="mb-4"><div className="text-sm font-bold text-gray-300">\$5,000</div><span className="font-bold">VC3D stability improvements</span>: Philip Allgaier / @spacegaier</div>
     <img src="https://substackcdn.com/image/fetch/$s_!nbQK!,w_1456,c_limit,f_webp,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F73a073b2-09f3-478c-b9bd-2e6141703df8_1669x995.png"/>
   </a>

@@ -160,7 +160,7 @@ We favor submissions that:
 * Are **well documented**. It helps a lot if relevant documentation, walkthroughs, images, tutorials or similar are included with the work so that others can use it!
 
 We maintain a [public wishlist](https://github.com/ScrollPrize/villa/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22help%20wanted%22) of ideas that would make excellent progress prize submissions.
-[Improvements to VC3D](https://github.com/ScrollPrize/volume-cartographer/issues) can be also considered for progress prizes!
+[Improvements to VC3D](https://github.com/ScrollPrize/villa/issues?q=is%3Aissue%20state%3Aopen%20label%3AVC3D) can be also considered for progress prizes!
 Some are additionally labeled as [good first issues](https://github.com/ScrollPrize/villa/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22) for newcomers!
 
 Submissions are evaluated monthly, and multiple submissions/awards per month are permitted. The next deadline is 11:59pm Pacific, August 31th, 2025!

@@ -76,7 +76,7 @@ sudo docker run hello-world
 
 **Pull the container image**
 
-While it is possible to build this from source, we recommend just pulling the container image from our [volume-cartographer repository](https://github.com/ScrollPrize/volume-cartographer) by entering the following command:
+While it is possible to build this from source, we recommend just pulling the container image from our [volume-cartographer repository](https://github.com/ScrollPrize/villa/tree/main/volume-cartographer) by entering the following command:
 ```bash
 sudo docker pull ghcr.io/scrollprize/volume-cartographer:edge
 ```

@@ -5,10 +5,20 @@ virtually unwrapping volumetric datasets. It was designed to recover text from
 CT scans of ancient, badly damaged manuscripts, but can be applied in many
 volumetric analysis applications.
 
+This repository is a version of [EduceLab](https://educelab.engr.uky.edu/)'s Volume Cartographer.
+Via Vesuvius Challenge, it has gone through a few forks:
+[EduceLab](https://github.com/educelab/volume-cartographer) (original) ->
+[Julian Schilliger](https://github.com/schillij95/volume-cartographer-papyrus) (optical flow segmentation) ->
+[Philip Allgaier](https://github.com/spacegaier/volume-cartographer) (performance/usability improvements) ->
+[Hendrik Schilling and Sean Johnson](https://github.com/hendrikschilling/volume-cartographer) (various improvements) ->
+this repository (developed and maintained by the Vesuvius Challenge team).
+The original Volume Cartographer is a general purpose toolkit for virtual unwrapping, while this version is specialized for the frontier challenges of the Herculaneum papyri.
+
+
 ## WIP 3D volume slicing
 - ome-zarr enabled VC is available as *VC3D* alongside the existing VC binary
 - this branch implements (OME)-Zarr based volume viewing and arbitrary plane slicing, currently used to show XY,YZ,XZ planes + 1 plane with free rotation
-- along the way a lot of functionaltiy was disabled/broken - for now use it just to look at stuff, do not touch segmentation
+- along the way a lot of functionality was disabled/broken - for now use it just to look at stuff, do not touch segmentation
 - usage
   - you need a Zarr volume (e.g. https://dl.ash2txt.org/other/dev/scrolls/1/volumes/54keV_7.91um.zarr/) in the volumes directory of your volpkg
   - it needs a meta.json in the .zarr directory, which can be identical to the regular volume apart from:
@@ -18,7 +28,7 @@ volumetric analysis applications.
   - currently only uint8 datatype is supported (but any compression thats compiled into z5)
   - currently scale 0 (highest resolution) will be ignored and can be left out (which means ~90GB of data for the volume linked above)
     - note that the metadata for scale 0 still needs to be present ("0/.zarray")
-  - by default VC will only load scale 1 or higher from the Zarr voluem, so you do not need to download the highest resolution scale 0
+  - by default VC will only load scale 1 or higher from the Zarr volume, so you do not need to download the highest resolution scale 0
   - the default chunk cache is 10GB of RAM
 - features
   - big yellow circle marks the slicing center