-
Notifications
You must be signed in to change notification settings - Fork 2
ENH: Specify Python 3.11 for nightly health / remote runner #83
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
c2c2c13
ENH: Specify Python 3.11 for nightly health / remote runner
aylward a40c371
ENH: Code rabbit
aylward ec32963
ENH: Coderabbit - and unreachable code in vtk_to_usd/usd_utils
aylward 4fd8d4f
BUG: Fix url to SlicerHeart
aylward 0a9216c
ENH: Simplify top-level data/README, delegating details to subdirs
aylward File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,6 +13,9 @@ build | |
| __pycache__ | ||
| _version.py | ||
| htmlcov | ||
| .cursor | ||
| .vscode/* | ||
| !.vscode/settings.json | ||
|
|
||
| # AI files | ||
| .claude | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,61 +1,33 @@ | ||
| # PhysioTwin4D Data Directory | ||
|
|
||
| This directory holds the example datasets used by PhysioTwin4D's tutorials, | ||
| experiments, and tests. Each subdirectory is one dataset and has its own | ||
| `README.md` with the download URL(s), directory layout, data sizes, and the | ||
| exact `physiotwin4d-download-data` command for that dataset. This file is | ||
| just the map — see the subdirectory README before downloading anything. | ||
| This directory holds the sample datasets used for experiments, testing, and | ||
| development of the PhysioTwin4D library. Each subdirectory contains one | ||
| dataset and its own `README.md` with download instructions, specifications, | ||
| and citation — this file is just an index; treat the per-dataset READMEs as | ||
| the source of truth. | ||
|
|
||
| ## Datasets | ||
|
|
||
| | Directory | Data Type | Provided By | Auto-Download | | ||
| | ----------------------------------- | ------------------------------------------------------- | --------------------------------------- | ------------- | | ||
| | [`Slicer-Heart-CT/`](Slicer-Heart-CT/README.md) | 4D gated cardiac CT (`.seq.nrrd`) | Jolley Lab (CHOP) / SlicerHeart on GitHub | Yes | | ||
| | [`DirLab-4DCT/`](DirLab-4DCT/README.md) | 4D lung CT respiratory benchmark + landmarks (`.mhd/.raw`) | DIR-Lab (Emory / MD Anderson) | No — manual, may require registration | | ||
| | [`KCL-Heart-Model/`](KCL-Heart-Model/README.md) | Statistical heart shape model meshes (`.vtk`) | King's College London, via Zenodo | Yes | | ||
| | [`CHOP-Valve4D/`](CHOP-Valve4D/README.md) | FEBio valve FE model, converted to VTK/ITK + Simpleware segmentation | Jolley Lab (CHOP), converted by PhysioTwin4D | Yes | | ||
|
|
||
| [`data/test/`](test/README.md) is not a dataset — it is a cache | ||
| automatically managed by the pytest infrastructure (mainly from | ||
| `Slicer-Heart-CT`) and is not used by the workflows, tutorials, or CLIs. | ||
|
|
||
| ## Downloading Data | ||
|
|
||
| Datasets marked **Yes** above can be fetched with the | ||
| `physiotwin4d-download-data` CLI (or the corresponding | ||
| `DataDownloadTools.Download*` method), for example: | ||
|
|
||
| ```bash | ||
| physiotwin4d-download-data Slicer-Heart-CT --directory data/Slicer-Heart-CT | ||
| physiotwin4d-download-data KCL-Heart-Model --directory data/KCL-Heart-Model | ||
| physiotwin4d-download-data CHOP-Valve4D --directory data/CHOP-Valve4D | ||
| ``` | ||
|
|
||
| Datasets marked **No** must be downloaded by hand following the | ||
| instructions in that dataset's own README (`DirLab-4DCT/README.md`). | ||
|
|
||
| ### Verification Helpers | ||
|
|
||
| Each dataset also has a `DataDownloadTools.Verify*Data()` helper that checks | ||
| whether the expected files are already present, so scripts can skip | ||
| downloading when the data is cached: | ||
|
|
||
| ```python | ||
| from physiotwin4d import DataDownloadTools | ||
|
|
||
| DataDownloadTools.VerifySlicerHeartCTData("data/Slicer-Heart-CT") | ||
| DataDownloadTools.VerifyDirLab4DCTData("data/DirLab-4DCT") | ||
| DataDownloadTools.VerifyKCLHeartModelData("data/KCL-Heart-Model") | ||
| DataDownloadTools.VerifyCHOPValve4DData("data/CHOP-Valve4D") | ||
| ``` | ||
|
|
||
| ## Guidelines | ||
|
|
||
| - Keep original downloaded data unmodified; write experiment/tutorial | ||
| results under `experiments/*/results/` or `tutorials/*/results/`, not | ||
| back into `data/`. | ||
| - Always respect the license and citation requirements of each dataset — | ||
| see the "Citation" / "Acknowledgement" section in the relevant | ||
| subdirectory README. | ||
| - If you add a new dataset, add both a row above and a subdirectory | ||
| `README.md` following the existing datasets as a template. | ||
| | Directory | Description | Provided By | Download | README | | ||
| | --- | --- | --- | --- | --- | | ||
| | `Slicer-Heart-CT/` | 4D cardiac CT with gated cardiac phases | Jolley Lab, Children's Hospital of Philadelphia (CHOP) | Automatic | [Slicer-Heart-CT/README.md](Slicer-Heart-CT/README.md) | | ||
| | `DirLab-4DCT/` | 4D lung CT respiratory motion benchmark | DIR-Lab, MD Anderson Cancer Center / Emory University | Manual | [DirLab-4DCT/README.md](DirLab-4DCT/README.md) | | ||
| | `KCL-Heart-Model/` | Statistical shape model of the heart | King's College London (KCL) | Automatic | [KCL-Heart-Model/README.md](KCL-Heart-Model/README.md) | | ||
| | `CHOP-Valve4D/` | 4D valve reconstruction models | Jolley Lab, CHOP (original FEBio model) | Automatic | [CHOP-Valve4D/README.md](CHOP-Valve4D/README.md) | | ||
| | `test/` | pytest-managed cache; not a downloadable dataset | — | N/A | [test/README.md](test/README.md) | | ||
|
|
||
| ## Automatic Download | ||
|
|
||
| `Slicer-Heart-CT`, `KCL-Heart-Model`, and `CHOP-Valve4D` can be fetched with | ||
| the `physiotwin4d-download-data` CLI or `DataDownloadTools`; see each | ||
| dataset's README for the exact command. `DirLab-4DCT` has no automatic | ||
| downloader — DIR-Lab distributes each case individually and may require | ||
| registration, so it must be obtained manually; see | ||
| [DirLab-4DCT/README.md](DirLab-4DCT/README.md). | ||
|
|
||
| ## Notes | ||
|
|
||
| - Always cite the original data source in publications — see each dataset's | ||
| README for the required citation. | ||
| - The full set of datasets is ~10-20 GB; ensure adequate disk space before | ||
| downloading everything. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.