Upload README.md

README.md

@@ -479,13 +479,233 @@ Each scene should include `points.ply`.
 
 The initial point cloud was obtained by back-projecting the pixels from each camera view in the first frame based on depth, followed by randomly sampling 100,000 points from the resulting data.
 
-<h2 id="how-to-download" style="margin-left: 0; font-size: 1.9em; line-height: 1.22; margin-top: 1.2em; margin-bottom: 0.5em;">📥 How to Download</h2><h3 id="download-scripts" style="font-size: 1.35em; margin-top: 0.75em; margin-bottom: 0.22em; line-height: 1.2; margin-left: 24px;">1. Download Scripts</h3><h3 id="install-dependencies" style="font-size: 1.35em; margin-top: 0.75em; margin-bottom: 0.22em; line-height: 1.2; margin-left: 24px;">2. Install Dependencies</h3><h3 id="filter-cases" style="font-size: 1.35em; margin-top: 0.75em; margin-bottom: 0.22em; line-height: 1.2; margin-left: 24px;">3. Filter Cases</h3><h4 id="filter-by-split" style="font-size: 1.12em; margin-top: 0.55em; margin-bottom: 0.14em; line-height: 1.18; margin-left: 48px;">3.1 Filter by split</h4><h4 id="filter-by-split-and-activity" style="font-size: 1.12em; margin-top: 0.55em; margin-bottom: 0.14em; line-height: 1.18; margin-left: 48px;">3.2 Filter by split and activity complexity</h4><h4 id="filter-by-phenomenon" style="font-size: 1.12em; margin-top: 0.55em; margin-bottom: 0.14em; line-height: 1.18; margin-left: 48px;">3.3 Filter by physical phenomenon abbreviation</h4><h4 id="random-sampling" style="font-size: 1.12em; margin-top: 0.55em; margin-bottom: 0.14em; line-height: 1.18; margin-left: 48px;">3.4 Randomly sample a fixed number of cases</h4><h3 id="download-selected-cases" style="font-size: 1.35em; margin-top: 0.75em; margin-bottom: 0.22em; line-height: 1.2; margin-left: 24px;">4. Download Selected Cases</h3>
+</div>
+
+</div>
+
+<h2 id="how-to-download" style="margin-left: 0; font-size: 1.9em; line-height: 1.22; margin-top: 1.2em; margin-bottom: 0.5em;">📥 How to Download</h2>
+<div style="margin-left: 24px;">
+<div style="margin-left: 24px;">
+
+
+PhysInOne is distributed across multiple Hugging Face dataset repositories because of its large scale. We provide two scripts for selecting and downloading cases:
+
+- `filter_cases.py`: parses the case-to-repository assignment file and exports selected cases to JSON.
+- `download.py`: downloads the selected case zip files from the corresponding Hugging Face shard repositories.
+
+The `filter_cases.py` script supports selection by:
+
+- Split: `train`, `val`, `test`
+- Activity complexity: `single`, `double`, `triple`
+- Physical phenomenon abbreviation: `MovingHitsFixed`, `FrictionStop`, `LiquidTension`, ..., `GranularFall`
+- Number of cases: globally sample `num` cases after filtering
+
+</div>
+<h3 id="download-scripts" style="font-size: 1.35em; margin-top: 0.75em; margin-bottom: 0.22em; line-height: 1.2; margin-left: 24px;">1. Download Scripts</h3>
+<div style="margin-left: 24px;">
+<div style="margin-left: 24px;">
+
+
+Please download the `assets` folder, which contains:
+
+```text
+metadata/
+  repo_assignment.txt
+  repo_map.json
+scripts/
+  filter_cases.py
+  download.py
+```
+
+
+</div>
+<h3 id="install-dependencies" style="font-size: 1.35em; margin-top: 0.75em; margin-bottom: 0.22em; line-height: 1.2; margin-left: 24px;">2. Install Dependencies</h3>
+<div style="margin-left: 24px;">
+<div style="margin-left: 24px;">
+
+
+```bash
+pip install huggingface_hub tqdm
+```
+
+
+</div>
+<h3 id="filter-cases" style="font-size: 1.35em; margin-top: 0.75em; margin-bottom: 0.22em; line-height: 1.2; margin-left: 24px;">3. Filter Cases</h3>
+<div style="margin-left: 24px;">
+<div style="margin-left: 24px;">
+
+
+</div>
+<h4 id="filter-by-split" style="font-size: 1.12em; margin-top: 0.55em; margin-bottom: 0.14em; line-height: 1.18; margin-left: 48px;">3.1 Filter by split</h4>
+<div style="margin-left: 48px;">
+
+
+```bash
+python scripts/filter_cases.py \
+  --split train \
+  --output selected_cases.json
+```
+
+
+
+<h4 id="filter-by-split-and-activity" style="font-size: 1.12em; margin-top: 0.55em; margin-bottom: 0.14em; line-height: 1.18; margin-left: 48px;">3.2 Filter by split and activity complexity</h4>
+<div style="margin-left: 48px;">
+
+
+```bash
+python scripts/filter_cases.py \
+  --split train \
+  --activity_type double \
+  --output selected_cases.json
+```
+
+
+
+<h4 id="filter-by-phenomenon" style="font-size: 1.12em; margin-top: 0.55em; margin-bottom: 0.14em; line-height: 1.18; margin-left: 48px;">3.3 Filter by physical phenomenon abbreviation</h4>
+<div style="margin-left: 48px;">
+
+
+By default, phenomenon matching uses `contains` mode. For example, the following command selects all double-physics cases that contain `FrictionStop`:
+
+```bash
+python scripts/filter_cases.py \
+  --split train \
+  --activity_type double \
+  --phenomena FrictionStop \
+  --match_mode contains \
+  --output selected_cases.json
+```
+
+For exact matching, use `--match_mode exact`. Order does not matter. For example, this command selects cases whose phenomenon set is exactly `{AccelConcaveSpin, AccelSurfaceSpin}`:
+
+```bash
+python scripts/filter_cases.py \
+  --split train \
+  --activity_type double \
+  --phenomena AccelConcaveSpin AccelSurfaceSpin \
+  --match_mode exact \
+  --output selected_cases.json
+```
+
+
+
+<h4 id="random-sampling" style="font-size: 1.12em; margin-top: 0.55em; margin-bottom: 0.14em; line-height: 1.18; margin-left: 48px;">3.4 Randomly sample a fixed number of cases</h4>
+<div style="margin-left: 48px;">
+
+
+`--num` is the global number of cases sampled after filtering. The default random seed is `42`.
+
+```bash
+python scripts/filter_cases.py \
+  --split train \
+  --activity_type double \
+  --phenomena FrictionStop \
+  --num 3000 \
+  --seed 42 \
+  --output selected_cases.json
+```
+
+
+
+
+<h3 id="download-selected-cases" style="font-size: 1.35em; margin-top: 0.75em; margin-bottom: 0.22em; line-height: 1.2; margin-left: 24px;">4. Download Selected Cases</h3>
+<div style="margin-left: 24px;">
+<div style="margin-left: 24px;">
+
+
+Each selected case is downloaded as a zip file from the corresponding Hugging Face shard repository.
+
+```bash
+python scripts/download.py \
+  --selection selected_cases.json \
+  --output_dir ./PhysInOne
+```
+
+If the dataset repositories are gated or private, pass a Hugging Face token:
+
+```bash
+python scripts/download.py \
+  --selection selected_cases.json \
+  --output_dir ./PhysInOne \
+  --token YOUR_HF_TOKEN
+```
+
+By default, downloaded zip files are saved into a flat output folder. To preserve shard/split/activity structure:
+
+```bash
+python scripts/download.py \
+  --selection selected_cases.json \
+  --output_dir ./PhysInOne \
+  --keep_shard_structure
+```
+
+The preserved structure is:
+
+```text
+PhysInOne/
+  physinone_part1/
+    Train/
+      DoublePhysics/
+        AccelConcaveSpin_AccelSurfaceSpin__bg070__K5ER39_trajectory.zip
+```
+
+
+
+
+</div>
+</div>
+</div>
+</div>
+</div>
+</div>
+
+</div>
 
 <h2 id="license" style="margin-left: 0; font-size: 1.9em; line-height: 1.22; margin-top: 1.2em; margin-bottom: 0.5em;">📜 License</h2>
+<div style="margin-left: 24px;">
+
+
+All 3D assets and materials included in PhysInOne have been sourced from publicly available platforms and verified to carry licenses compatible with non-commercial use. These include:
+
+- SketchFab: assets under various licenses, verified that AI-related usage is allowed.  
+- Fab: assets under CC BY or Unreal Engine Standard License, explicitly permitting AI-related usage.  
+- BlenderKit: distributed under Royalty-Free (RF) license.  
+- ShareTextures: textures under CC0 license.  
+
+In total, assets comply with licenses including CC BY-NC, CC BY-SA, CC BY-NC-SA, CC0, CC BY, and RF, ensuring all files can be legally used for building a non-commercial dataset. Users must adhere to the original licenses for any redistribution or derivative work.  
+
+> ⚠️ Note: PhysInOne is intended for **non-commercial research and educational purposes**. For commercial use, users must verify the licensing terms of individual assets.
+
+</div>
 
 <h2 id="citation" style="margin-left: 0; font-size: 1.9em; line-height: 1.22; margin-top: 1.2em; margin-bottom: 0.5em;">📚 Citation</h2>
+<div style="margin-left: 24px;">
+
+
+If you use PhysInOne in your research, please cite:
+
+```bibtex
+@article{zhou2026physinone,
+  title={PhysInOne: Visual Physics Learning and Reasoning in One Suite},
+  author={Zhou, Siyuan and Wang, Hejun and Cheng, Hu and Li, Jinxi and Wang, Dongsheng and Jiang, Junwei and Jin, Yixiao and Huang, Jiayue and Mao, Shiwei and Liu, Shangjia and others},
+  journal={arXiv preprint arXiv:2604.09415},
+  year={2026}
+}
+```
+
+
+
+</div>
 
 <h2 id="contact" style="margin-left: 0; font-size: 1.9em; line-height: 1.22; margin-top: 1.2em; margin-bottom: 0.5em;">📮 Contact</h2>
+<div style="margin-left: 24px;">
+
+
+For questions about the dataset, please contact:
+
+- {siyuan.zhou, hejun.wang, hu123.cheng, jinxi.li}@connect.polyu.hk, bo.yang@polyu.edu.hk
+
+</div>
 
 </main>
 </div>