From 977a8731e2db83b9b0eff0365db147e076521730 Mon Sep 17 00:00:00 2001 From: Stephen Aylward Date: Wed, 5 Aug 2026 20:32:22 -0400 Subject: [PATCH] ENH: Add data download instructions to readme quickstart --- README.md | 8 ++++++++ docs/quickstart.rst | 8 +++++++- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ad4e666..45331a7 100644 --- a/README.md +++ b/README.md @@ -91,9 +91,17 @@ Clone it to run them: ```bash git clone https://github.com/Project-MONAI/physiotwin4d.git cd physiotwin4d + +# Tutorial 1 (heart) runs on the public Slicer-Heart 4D CT sample +physiotwin4d-download-data Slicer-Heart-CT --directory data/Slicer-Heart-CT + python tutorials/tutorial_01_heart_gated_ct_to_usd.py ``` +Run the download from the top level of the clone: the tutorials resolve their +inputs against the repository root, so downloading elsewhere puts the data +where they will not find it. + See the [quickstart](https://project-monai.github.io/physiotwin4d/quickstart.html) and [tutorials](https://project-monai.github.io/physiotwin4d/tutorials.html) for full walkthroughs covering segmentation, registration, statistical shape modeling, and USD export. ## Contributing diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 4396d9f..8d308ec 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -58,14 +58,20 @@ Then fetch the sample datasets, again from the top level of the clone: .. code-block:: bash + # Tutorials 1, 3 and 4 (heart) physiotwin4d-download-data Slicer-Heart-CT --directory data/Slicer-Heart-CT + + # Tutorial 6 (heart) physiotwin4d-download-data KCL-Heart-Model --directory data/KCL-Heart-Model + + # Tutorial 7 (lung) physiotwin4d-download-data Chest-CT --directory data/Chest-CT ``DirLab-4DCT`` is manual-only; see ``data/DirLab-4DCT/README.md``, and :doc:`cli_scripts/download_data` for every dataset's size and source. -With Slicer-Heart-CT in place, the first tutorial runs as a plain script: +Tutorial 1 needs only ``Slicer-Heart-CT``; with that dataset in place it runs +as a plain script: .. code-block:: bash