Super-squash branch 'main' using huggingface_hub

.gitattributes

@@ -0,0 +1,63 @@
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.avro filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ckpt filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.lz4 filter=lfs diff=lfs merge=lfs -text
+*.mds filter=lfs diff=lfs merge=lfs -text
+*.mlmodel filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.npy filter=lfs diff=lfs merge=lfs -text
+*.npz filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pickle filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+*.safetensors filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tar filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.wasm filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zst filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text
+# Audio files - uncompressed
+*.pcm filter=lfs diff=lfs merge=lfs -text
+*.sam filter=lfs diff=lfs merge=lfs -text
+*.raw filter=lfs diff=lfs merge=lfs -text
+# Audio files - compressed
+*.aac filter=lfs diff=lfs merge=lfs -text
+*.flac filter=lfs diff=lfs merge=lfs -text
+*.mp3 filter=lfs diff=lfs merge=lfs -text
+*.ogg filter=lfs diff=lfs merge=lfs -text
+*.wav filter=lfs diff=lfs merge=lfs -text
+# Image files - uncompressed
+*.bmp filter=lfs diff=lfs merge=lfs -text
+*.gif filter=lfs diff=lfs merge=lfs -text
+*.png filter=lfs diff=lfs merge=lfs -text
+*.tiff filter=lfs diff=lfs merge=lfs -text
+# Image files - compressed
+*.jpg filter=lfs diff=lfs merge=lfs -text
+*.jpeg filter=lfs diff=lfs merge=lfs -text
+*.webp filter=lfs diff=lfs merge=lfs -text
+# Video files - compressed
+*.mp4 filter=lfs diff=lfs merge=lfs -text
+*.webm filter=lfs diff=lfs merge=lfs -text
+packs/single_bundle_100ms_xframe.rpk filter=lfs diff=lfs merge=lfs -text
+packs/swoop_1s_c3_seg125ms.rpk filter=lfs diff=lfs merge=lfs -text
+packs/single_bundle_1s_c3_seg125ms.rpk filter=lfs diff=lfs merge=lfs -text

LICENSING.md

@@ -0,0 +1,30 @@
+# Licensing
+
+The replay packs of this dataset are dual-licensed.
+
+## Research and non-profit use — CC BY-NC-SA 4.0
+
+The packs, their manifest and their certificates are available under the
+[Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-nc-sa/4.0/).
+You may download, replay, redistribute and build upon them for research, teaching and any other non-commercial
+purpose, as long as you credit this dataset and its source geometry (the `citation` field of every pack) and
+release what you build upon them under the same terms.
+
+## Commercial use
+
+A commercial licence is available under separately negotiated terms for use that makes money: inside a product,
+a paid service, contract research, or the training of a model that is sold. It lifts the non-commercial and
+share-alike obligations.
+
+📧 **rutger.fick@dmrai-lab.org**
+
+## What the licence covers, and what it does not
+
+The licence covers the simulated records in the packs: the walkers' paths, occupancies, wall contacts and field
+samples, their coefficients, and the certificates. The **source geometry** each pack was simulated on keeps its
+own licence, recorded in the pack's `license` field and in the manifest, and this dataset never relicenses it.
+The replay-pack **format** is a separate, openly licensed specification (CC-BY-4.0 text, Apache-2.0 reference code):
+anyone may produce and read packs under their own terms.
+
+Copies of a pack obtained under an earlier licence of this dataset keep that licence; these terms apply from the
+revision that carries this file.

README.md

@@ -0,0 +1,37 @@
+---
+license:
+  - cc-by-nc-sa-4.0
+  - other
+pretty_name: cactus-axons
+---
+
+# SubstrateCommons/cactus-axons
+
+Replay packs (`.rpk`) built with `dmipy_sim`: one converged Monte-Carlo walk each, stored so any acquisition can be replayed on it. Load one with `ReplayPack.load("hf://SubstrateCommons/cactus-axons/<path>")`; the manifest (`manifest.json`) holds the sha256 every load is checked against. This file is rendered from the manifest by `dmipy_sim.replay.publish`.
+
+## Substrate
+
+`cactus/cactus_bundle_00000`
+
+* box: 30 × 30 × 30 µm
+* boundary: periodic, periodic, periodic
+
+| pool | D (m²/s) | water fraction |
+|---|---|---|
+| extra | 1.7e-09 | 1 |
+| intra | 1.7e-09 | 1 |
+| myelin | 0 | 0.4 |
+
+## Packs
+
+| id | duration | walkers | bands | channels | floor | size | commit | path |
+|---|---|---|---|---|---|---|---|---|
+| `cactus/single-bundle-1s-c3-seg125ms` | 1000 ms (8 × 125 ms, 472.0 MB/window) | 100000 | 320 | positions, boundary_local_time, compartment, susceptibility_grid, susceptibility_path | 0.0266 | 3.8 GB | — | `packs/single_bundle_1s_c3_seg125ms.rpk` |
+
+## Citation
+
+* Villarreal-Haro et al., CACTUS; dmipy-sim#285, #528
+
+## Licence
+
+The packs are distributed under `CC-BY-NC-SA-4.0 OR LicenseRef-Commercial` (the full terms: https://huggingface.co/datasets/SubstrateCommons/cactus-axons/blob/main/LICENSING.md). The source geometry of each pack keeps its own licence, recorded in the pack's `license` field: cc-by-4.0; the format never relicenses a source.

manifest.json

@@ -0,0 +1,87 @@
+{
+ "schema": "substratecommons/1",
+ "packs": [
+  {
+   "id": "cactus/single-bundle-1s-c3-seg125ms",
+   "path": "packs/single_bundle_1s_c3_seg125ms.rpk",
+   "sha256": "d6ae608da0e22ec66e4aa76fa74b0011beb48d3d931eea2854bf22af6ff714c8",
+   "bytes": 3777279912,
+   "n_walkers": 100000,
+   "T_max": 0.9999999999999999,
+   "dt_traj": 7.682851874615857e-05,
+   "K": 320,
+   "method": "bridge_dst",
+   "temporal_bandwidth_hz": 1280.0000000000002,
+   "channels": [
+    "positions",
+    "boundary_local_time",
+    "compartment",
+    "susceptibility_grid",
+    "susceptibility_path"
+   ],
+   "floor_max": 0.026649938919503673,
+   "err_max": 0.05077523742984075,
+   "within_2x_floor": false,
+   "commit": "e8c640e4cea22a91a17138620b116d8421d7484a",
+   "license": "CC-BY-4.0",
+   "citation": "Villarreal-Haro et al., CACTUS; dmipy-sim#285, #528",
+   "substrate": "cactus/cactus_bundle_00000",
+   "segments": {
+    "n": 8,
+    "n_t": 1628,
+    "T": 0.12499999999999999,
+    "walks": [
+     {
+      "first": 0,
+      "last": 7,
+      "seed": [
+       1001,
+       1002,
+       1003,
+       1004,
+       1005
+      ]
+     }
+    ]
+   },
+   "segment_bytes": 472016640,
+   "pack_license": "CC-BY-NC-SA-4.0 OR LicenseRef-Commercial",
+   "pack_license_url": "https://huggingface.co/datasets/SubstrateCommons/cactus-axons/blob/main/LICENSING.md"
+  }
+ ],
+ "substrate": {
+  "id": "cactus/cactus_bundle_00000",
+  "box_min": [
+   -1.4999999999999999e-05,
+   -1.4999999999999999e-05,
+   -1.4999999999999999e-05
+  ],
+  "box_max": [
+   1.4999999999999999e-05,
+   1.4999999999999999e-05,
+   1.4999999999999999e-05
+  ],
+  "boundary": [
+   "periodic",
+   "periodic",
+   "periodic"
+  ],
+  "pools": [
+   {
+    "name": "extra",
+    "D": 1.7e-09,
+    "water_fraction": 1.0
+   },
+   {
+    "name": "intra",
+    "D": 1.7e-09,
+    "water_fraction": 1.0
+   },
+   {
+    "name": "myelin",
+    "D": 0.0,
+    "water_fraction": 0.4
+   }
+  ]
+ }
+}

packs/single_bundle_1s_c3_seg125ms.rpk

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:d6ae608da0e22ec66e4aa76fa74b0011beb48d3d931eea2854bf22af6ff714c8
+size 3777279912