Skip to content

Commit 26d7a70

Browse files
authored
Merge pull request #180 from acgetchell/release/v0.1.0
chore(release): release v0.1.0
2 parents 76273cd + b84e790 commit 26d7a70

9 files changed

Lines changed: 951 additions & 836 deletions

File tree

CHANGELOG.md

Lines changed: 45 additions & 820 deletions
Large diffs are not rendered by default.

CITATION.cff

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ cff-version: 1.2.0
22
message: "If you use this software, please cite it as below."
33
type: software
44
title: "causal-triangulations: A Causal Dynamical Triangulation library for quantum gravity research"
5-
version: 0.0.1
5+
version: 0.1.0
66
url: "https://github.com/acgetchell/causal-triangulations"
77
repository-code: "https://github.com/acgetchell/causal-triangulations"
88
authors:

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "causal-triangulations"
3-
version = "0.0.1"
3+
version = "0.1.0"
44
authors = [ "Adam Getchell <adam@adamgetchell.org>" ]
55
categories = [ "science", "mathematics", "algorithms", "simulation" ]
66
edition = "2024"

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,8 @@ See [CHANGELOG.md](CHANGELOG.md) for release history.
3737

3838
## 🚧 Project Status
3939

40-
🚧 **v0.1.0 release-readiness** — The validated 1+1 CDT foundation is in place, including toroidal volume-changing moves, nonuniform initial volume
41-
profiles, upstream-backed MCMC sampler mechanics, and CI-aligned validation tooling. The crate remains unreleased at v0.1.0 until the release PR merges and the
42-
v0.1.0 package and tag are cut.
40+
**v0.1.0 foundation release** — The validated 1+1 CDT foundation is in place, including toroidal volume-changing moves, nonuniform initial volume profiles,
41+
upstream-backed MCMC sampler mechanics, trace/summary exports, resumable checkpoints, and CI-aligned validation tooling.
4342

4443
The library currently supports validated 1+1 CDT construction, foliation checks, Metropolis sampling, resumable checkpoints, and core observables.
4544
Higher-dimensional CDT support, visualization/export workflows, and advanced ensemble-analysis helpers remain roadmap work.
@@ -48,7 +47,7 @@ See [`docs/roadmap.md`](docs/roadmap.md) for current direction, near-term candid
4847

4948
## ⚙️ Requirements
5049

51-
- Rust 1.95 or newer (required by dependencies such as `delaunay` and `la-stack`)
50+
- Rust 1.96.0 or newer (pinned by `Cargo.toml` and `rust-toolchain.toml`)
5251

5352
**Why Rust for CDT?**
5453

docs/CLI_EXAMPLES.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ The `cdt` binary accepts various command-line arguments to configure and run CDT
4040

4141
### Physics Parameters
4242

43-
- `--coupling-0 <κ₀>`: Coupling constant for vertices (default: 1.0)
44-
- `--coupling-2 <κ₂>`: Coupling constant for triangles (default: 1.0)
43+
- `--coupling-0 <κ₀>`: Coupling constant for vertices (default: 0.0)
44+
- `--coupling-2 <κ₂>`: Coupling constant for triangles (default: 0.0)
4545
- `--cosmological-constant <λ>`: Edge-count cosmological constant (default: `(2 / 3) ln 2`)
4646

4747
### Additional Options
@@ -271,9 +271,16 @@ RUST_LOG=warn ./target/release/cdt --vertices-per-slice 5 --timeslices 10 --simu
271271
### Data Analysis
272272

273273
```bash
274-
# Pipe triangulation-only output to analysis tools
275-
./target/release/cdt --vertices-per-slice 5 --timeslices 10 | \
276-
python analysis_script.py
274+
# Write stable interchange files for dataframe or notebook tools
275+
./target/release/cdt \
276+
--vertices-per-slice 5 \
277+
--timeslices 10 \
278+
--steps 200 \
279+
--thermalization-steps 20 \
280+
--measurement-frequency 10 \
281+
--simulate \
282+
--output-csv trace.csv \
283+
--output-json summary.json
277284
```
278285

279286
### Automation

docs/archive/changelog/0.0.md

Lines changed: 878 additions & 0 deletions
Large diffs are not rendered by default.

docs/roadmap.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,12 @@ polish that are useful but not required for the first DOI-backed foundation rele
6161
- Add λ scan utilities for unfixed-volume 1+1 CDT runs
6262
([#143](https://github.com/acgetchell/causal-triangulations/issues/143)). These should help users tune the cosmological constant, which is conjugate to the
6363
lattice volume term and controls volume growth or shrinkage in unfixed-volume runs.
64+
- Add a Polars notebook workflow for CDT analysis caches
65+
([#176](https://github.com/acgetchell/causal-triangulations/issues/176)). This should show how to load the v0.1.0 CSV/JSON outputs, reshape volume-profile
66+
data for exploratory analysis, and cache local Parquet files without adding plotting or Parquet dependencies to the Rust crate.
67+
- Ship prebuilt `cdt` release binaries
68+
([#169](https://github.com/acgetchell/causal-triangulations/issues/169)). This should make the command-line tool easier to try after the first source and
69+
crates.io release, while keeping `cargo install` and local release builds supported.
6470
- Adopt the upstream lift-aware simplex barycenter helper once `delaunay#420` ships
6571
([#147](https://github.com/acgetchell/causal-triangulations/issues/147)). This should replace the local `(1,3)` insertion-point policy while preserving the
6672
existing k=1 flip delegation, and is dependency-gated cleanup for move-kernel geometry ownership rather than a new CDT ensemble.

examples/scripts/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This directory contains shell scripts that demonstrate how to use the `cdt` comm
1818
**What it does**:
1919

2020
- Builds the cdt binary in release mode
21-
- Builds a 10-vertex, 5-timeslice command with 1000 requested MC steps
21+
- Builds a 4-vertices-per-slice, 5-timeslice command with 1000 requested MC steps
2222
- Shows logging output for a short `--simulate` run
2323

2424
**Use this for**: First-time testing, verifying installation
@@ -100,7 +100,7 @@ Each script has configuration variables at the top that you can easily modify:
100100

101101
```bash
102102
# Edit the simulation parameters in the script
103-
VERTICES=10
103+
VERTICES_PER_SLICE=4
104104
TIMESLICES=5
105105
STEPS=1000
106106
TEMPERATURE=1.0
@@ -111,7 +111,7 @@ TEMPERATURE=1.0
111111
```bash
112112
# Modify temperature range or fixed parameters
113113
TEMPERATURES=(0.5 0.8 1.0 1.2 1.5 2.0 2.5 3.0)
114-
VERTICES=20
114+
VERTICES_PER_SLICE=4
115115
TIMESLICES=8
116116
STEPS=2000
117117
```
@@ -142,7 +142,7 @@ echo "=== Custom CDT Script ==="
142142
# Build the binary
143143
cargo build --release
144144

145-
# Run with custom parameters. Remove --simulate for a successful triangulation-only run.
145+
# Run with custom parameters. Remove --simulate when you only want triangulation construction.
146146
RUST_LOG=info ./target/release/cdt \
147147
--vertices-per-slice 4 \
148148
--timeslices 10 \

0 commit comments

Comments
 (0)