diff --git a/CHANGELOG.md b/CHANGELOG.md index 34e4122..e3b3ed0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,11 @@ Versions follow [semantic versioning](https://semver.org). While the version is 0.x the project is in early development: anything may change from one version to the next, configurations and results included. Each version says what changed in what a run does, so that a result can be tied to the version that produced it. -## Unreleased +## 0.2.0 (2026-11-01) + +A tissue that grows in a volume, and a spheroid in it that stops near the size measured spheroids reach, once its dead core breaks down and the medium of its well is still. Experimental. + +One change is incompatible: a network file that still sets `j_medium`, `j_self_base` or `j_self_from_growth` is refused, since nothing ever read them (first item below). - **Contact energies are not a network's.** A network file's `[mechanics]` carried `j_medium`, `j_self_base` and `j_self_from_growth`, read into every cell and handed to nothing: the lattice has always priced a boundary by the kinds of the cells across it (chapter 1). They are removed from the example networks, and a network that sets them, or any other unknown key under `[mechanics]`, is now refused with the key named. No run changes. - **A tissue in a volume.** A configuration's `depth` stacks slices: a tumour in a bath or around a vessel grows in three dimensions, cells dividing across planes, a vessel running through the box as a cylinder, the bath coming in from six faces, radii those of balls (chapter 26). A plane, one slice deep, runs exactly as it did: every example gives the same output, byte for byte. `max_cells` replaces the fixed ceiling of 2000 living cells. @@ -14,6 +18,9 @@ Versions follow [semantic versioning](https://semver.org). While the version is - **A waste that arrests.** A configuration's `[waste]` has every living cell release a waste, Greenspan's inhibitor, that diffuses as oxygen does and that the bath washes away; each cell's network reads it as the input `waste`. `examples/networks/ras-erk-waste.toml` gives the arrest to a node p27 raised by HIF-1α and by the waste (chapter 27). Left out, every run is the run it was; a gained link still reads only the four earlier inputs. - **A factor the dead release.** A configuration's `[necrotic_factor]` has every dead pixel release a factor that diffuses and that the bath washes away, as Freyer found the necrosis of spheroids does, and each cell's network reads it as `necrotic_factor`. A new term, `damaged_above`, damages a node past a level of its source; `examples/networks/ras-erk-necrotic.toml` has the factor kill through BCL2. Left out, every run is the run it was. - **A still medium.** A configuration's `[still_medium]` has the bath's medium still, oxygen diffusing through it at its `diffusion`: the level next to a spheroid in a volume is then that of a still medium around a ball, lower the more the spheroid takes up, as measured at the surface of spheroids in culture (chapter 27). The spheroid in a volume runs in one, its diffusion set against the measured spheroids' end, and stops at 368 µm against their 348, its cores growing with size as theirs do, by half as much. Left out, the medium is held at the source's level up to the tissue, and every run is the run it was. +- **A volume in the viewer.** A tissue grown in a volume is drawn as its voxels, cut open through the middle so that its core shows; C opens and closes the cut (chapter 26). +- **Legends on the animations.** Every animation in the README says in its corner what its colours mean, and the README says they are sped up. +- **The spheroid in a volume, in the README.** `examples/spheroid-3d.toml`, recorded in the viewer and cut open, from one ball of cells to its end. ## 0.1.0 (2026-10-30) diff --git a/CITATION.cff b/CITATION.cff index 58d0db2..07151aa 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -8,8 +8,8 @@ authors: given-names: Nicolas license: MIT repository-code: "https://github.com/ngodzik/cellweave" -version: 0.1.0 -date-released: 2026-10-30 +version: 0.2.0 +date-released: 2026-11-01 keywords: - cellular Potts model - multiscale modelling diff --git a/Cargo.lock b/Cargo.lock index b76114e..d8647c8 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -80,7 +80,7 @@ checksum = "fc652a48c352aef3ea3aed32080501cf3ef6ed5da78602a020c991775b0aff04" [[package]] name = "cellweave" -version = "0.1.0" +version = "0.2.0" dependencies = [ "anyhow", "cellweave-core", @@ -93,7 +93,7 @@ dependencies = [ [[package]] name = "cellweave-core" -version = "0.1.0" +version = "0.2.0" dependencies = [ "proptest", "serde", @@ -102,7 +102,7 @@ dependencies = [ [[package]] name = "cellweave-engine" -version = "0.1.0" +version = "0.2.0" dependencies = [ "cellweave-core", "ndarray", @@ -115,7 +115,7 @@ dependencies = [ [[package]] name = "cellweave-io" -version = "0.1.0" +version = "0.2.0" dependencies = [ "anyhow", "cellweave-core", diff --git a/Cargo.toml b/Cargo.toml index 78dd11d..c712212 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -11,7 +11,7 @@ resolver = "3" exclude = ["viewer"] [workspace.package] -version = "0.1.0" +version = "0.2.0" edition = "2024" # The oldest toolchain the code is known to build on. CI holds it to this, so # the sentence in the README is checked rather than asserted. @@ -20,9 +20,9 @@ authors = ["Nicolas Godzik"] license = "MIT" [workspace.dependencies] -cellweave-core = { path = "crates/core", version = "0.1.0" } -cellweave-engine = { path = "crates/engine", version = "0.1.0" } -cellweave-io = { path = "crates/io", version = "0.1.0" } +cellweave-core = { path = "crates/core", version = "0.2.0" } +cellweave-engine = { path = "crates/engine", version = "0.2.0" } +cellweave-io = { path = "crates/io", version = "0.2.0" } thiserror = "2" anyhow = "1" diff --git a/README.md b/README.md index 9c3e030..eafe1fb 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ **A tissue that grows, starves, mutates, calls for blood and is hunted by immune cells, simulated cell by cell from a hypothesis written in a file, and set against real measurements.**

- A spheroid growing from one cell, turning in relief: a rim of dividing cells around arrested ones, and a dead core forming where oxygen runs out + A spheroid growing in a volume from a ball of cells, cut open through the middle: a thin rim of dividing cells, arrested cells beneath it, and a dead core that breaks down, until it stops

> **Status: experimental, version 0.x.** cellweave is a research and teaching tool in early development, and anything in it may change from one version to the next. What it produces are hypotheses worth testing, not facts about real tumours. It gets better through feedback from people who know the biology or the modelling: a mechanism that is wrong or too simple, public data it should be set against, a value that should be different. If that is you, please [open a scientific feedback issue](https://github.com/ngodzik/cellweave/issues/new?template=scientific-feedback.md). Every comment is read. @@ -35,15 +35,20 @@ Every cell is a set of pixels with a shape, pressing on its neighbours. Inside e The animations are sped up: a few seconds stand for days to months of a tissue's life. Each says in its corner what its colours mean. -Also in it: a spheroid that starves from the inside at the size measured spheroids do ([chapter 25](docs/25-measured-against-spheroids.md)), a lethal stress and the resistance it selects, rewinding a history to see what one mutation changed, and campaigns that run many histories side by side. +Also in it: the spheroid at the top, grown in a volume, which stops near the size measured spheroids stop at once the medium of its well is still ([chapter 27](docs/27-spheroids-in-a-volume.md)), the same spheroid in the plane ([chapter 25](docs/25-measured-against-spheroids.md)), a lethal stress and the resistance it selects, rewinding a history to see what one mutation changed, and campaigns that run many histories side by side. ## Set against real data The values below are fixed by public measurements, and every comparison is in the course with the prediction written before it ran, the ones that failed included; what no public data fixes yet is listed in its last chapter. The data are never copied here: each dataset is a [recipe](datasets/) saying where its authors published it, and `scripts/fetch-dataset.py` downloads it to your machine. +

+ A spheroid growing from one cell, turning in relief: a rim of dividing cells around arrested ones, and a dead core forming where oxygen runs out +

+ | what | public data | how close | |---|---|---| | a tumour's oxygen | 994 melanoma spheroids ([Browning 2021](https://doi.org/10.7554/eLife.73020)) | one number fitted; arrest then starts where the spheroids' does; their late cycling rim is thinner | +| a spheroid's end, in a volume | the same spheroids; oxygen's diffusion in tissue ([Grote 1977](https://doi.org/10.1007/BF00582204)) and in culture medium ([Place 2017](https://doi.org/10.1016/j.freeradbiomed.2017.10.003)) | stops at 368 µm against 348, one number set inside the bracket the two diffusions leave; its core grows with size half as much as theirs | | cords of tissue around a vessel | [Tannock 1968](https://doi.org/10.1038/bjc.1968.34) | 69 µm against 60 to 120, nothing fitted | | immune killing | [Weigelin 2021](https://doi.org/10.1038/s41467-021-25282-3), [Halle 2016](https://doi.org/10.1016/j.immuni.2016.01.010) | set on the measured rates | | clones in a normal tissue | 1,222 clones of the mouse oesophagus ([Piedrafita 2020](https://doi.org/10.1038/s41467-020-15258-0)) | a third too large at a month, five times at six: a mechanism is missing | diff --git a/docs/media/volume.webp b/docs/media/volume.webp new file mode 100644 index 0000000..c7baf33 Binary files /dev/null and b/docs/media/volume.webp differ diff --git a/viewer/Cargo.lock b/viewer/Cargo.lock index c50db02..56b8b56 100644 --- a/viewer/Cargo.lock +++ b/viewer/Cargo.lock @@ -1648,7 +1648,7 @@ dependencies = [ [[package]] name = "cellweave-core" -version = "0.1.0" +version = "0.2.0" dependencies = [ "serde", "thiserror 2.0.21", @@ -1656,7 +1656,7 @@ dependencies = [ [[package]] name = "cellweave-engine" -version = "0.1.0" +version = "0.2.0" dependencies = [ "cellweave-core", "ndarray", @@ -1668,7 +1668,7 @@ dependencies = [ [[package]] name = "cellweave-io" -version = "0.1.0" +version = "0.2.0" dependencies = [ "anyhow", "cellweave-core", @@ -1682,7 +1682,7 @@ dependencies = [ [[package]] name = "cellweave-viewer" -version = "0.1.0" +version = "0.2.0" dependencies = [ "anyhow", "bevy", diff --git a/viewer/Cargo.toml b/viewer/Cargo.toml index 27e7580..096a99c 100644 --- a/viewer/Cargo.toml +++ b/viewer/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "cellweave-viewer" -version = "0.1.0" +version = "0.2.0" edition = "2024" # Bevy 0.20's own minimum, which the simulator's workspace matches so that the # repository has one toolchain to install.