Blame for Utils/3D_ASSETS_DOWNLOAD.md

# PhysInOne 3D Assets

This guide explains how to download, extract, and open the currently released
PhysInOne Unreal Engine project assets. The release contains shared project
files, Train and Val resource libraries, and Scene/Trajectory resources for
14,847 validation scenes and 120,660 training scenes. The 273 validation
origins reserved for the Motion Transfer test set are intentionally excluded.

Repository location:

[`Assets/PhysicBenchmark`](https://huggingface.co/datasets/vLAR/PhysInOne/tree/main/Assets/PhysicBenchmark)

## Requirements

- Unreal Engine **5.5.4**
- Python 3.9 or newer for the automated downloader
- Approximately **140 GiB** for the compressed public release alone
- Substantially more free disk space when keeping both ZIP files and extracted assets

Windows is recommended for the simplest Unreal Engine setup. Linux is also
supported, but platform plugins, permissions, and case-sensitive paths may
require additional configuration.

## Automated setup

The public downloader uses only the Python standard library and anonymous HTTPS.
Clone the GitHub repository, which contains the script and exact release
manifest:

```bash
git clone https://github.com/vLAR-group/PhysInOne.git
cd PhysInOne
python scripts/download_data.py --task 3d-assets --output-dir ./PhysInOne_data
```

The default command:

1. Downloads the exact current public release list.
2. Maps the project to the space-free local path `assets/PhysicBenchmark/`.
3. Validates ZIP paths and rejects unsafe archive members.
4. Extracts all 285 released ZIP files into their current parent directories.
5. Merges Train and Val resources without overwriting different files.
6. Writes resumable extraction markers and detailed success/failure logs.
7. Shows live file count, estimated size, download speed, and ETA.

After completion, launch:

```text
PhysInOne_data/assets/PhysicBenchmark/PhysInOne.uproject
```

## Download without extraction

```bash
python scripts/download_data.py --task 3d-assets \
  --output-dir ./PhysInOne_data \
  --no-extract
```

Run the default command later with the same output directory to extract the
archives.

## Save disk space

```bash
python scripts/download_data.py --task 3d-assets \
  --output-dir ./PhysInOne_data \
  --delete-zip-after-extract
```

A ZIP is deleted only after successful validation and extraction. Completion
markers prevent it from being downloaded again when the same command resumes.

## Current release contents

- 4,585 downloadable files
- 285 ZIP archives
- Approximately 139.67 GiB before extraction
- Scene and Trajectory resources for 14,847 validation scenes
- Scene and Trajectory resources for 120,660 training scenes
- Six validation resource archives and seven training resource archives
- Shared Unreal Engine project files and dependencies
- Ten Movie Render Queue configurations under `Content/PhysInOne/Scripts/`

Maintained lists:

- [`released.txt`](https://huggingface.co/datasets/vLAR/PhysInOne/blob/main/Utils/3d_assets_lists/released.txt): every file downloaded by `--task 3d-assets`
- [`released_archives.txt`](https://huggingface.co/datasets/vLAR/PhysInOne/blob/main/Utils/3d_assets_lists/released_archives.txt): all 285 archives extracted by default
- [`validation.txt`](https://huggingface.co/datasets/vLAR/PhysInOne/blob/main/Utils/3d_assets_lists/validation.txt): the validation-only subset
- [`validation_archives.txt`](https://huggingface.co/datasets/vLAR/PhysInOne/blob/main/Utils/3d_assets_lists/validation_archives.txt): the 36 validation archives
- [`summary.json`](https://huggingface.co/datasets/vLAR/PhysInOne/blob/main/Utils/3d_assets_lists/summary.json): release counts and byte sizes

## Archives and extraction destinations

Every ZIP must be extracted **in place**, into its current parent directory.
Scene and Trajectory files are deliberately packaged separately.

| Archive pattern, relative to `PhysicBenchmark/` | Member paths | Extract in |
| --- | --- | --- |
| `Content/PhysInOne/Scenes/val_scenes_batch_*.zip` | `Val/<Physics>/<Scene>.umap` | `Content/PhysInOne/Scenes/` |
| `Content/PhysInOne/Scenes/train_scenes_batch_*.zip` | `Train/<Physics>/<Scene>.umap` | `Content/PhysInOne/Scenes/` |
| `Content/PhysInOne/Trajectories/val_trajectory_batch_*.zip` | `Val/<Physics>/<Scene>_trajectory.uasset` | `Content/PhysInOne/Trajectories/` |
| `Content/PhysInOne/Trajectories/train_trajectory_batch_*.zip` | `Train/<Physics>/<Scene>_trajectory.uasset` | `Content/PhysInOne/Trajectories/` |
| `Content/PhysInOne/<Resource>/Val.zip` | `Val/...` | its current `<Resource>/` parent |
| `Content/PhysInOne/<Resource>/Train.zip` | `Train/...` | its current `<Resource>/` parent |

Because members begin with their split directory, Train and Val ZIPs can share
one remote parent directory without colliding after extraction.

The Train Scene and Trajectory series each span batches `0000–0120`; the Val
series each span batches `0000–0014`. The final Train batch contains 660 scenes,
and the final Val batch contains 847 scenes.

## Expected project structure

```text
PhysicBenchmark/
├── PhysInOne.uproject
├── Config/
├── DerivedDataCache/
└── Content/
    ├── Collections/
    ├── Ice/
    ├── StarterContent/
    ├── __ExternalActors__/
    ├── __ExternalObjects__/
    └── PhysInOne/
        ├── Backgrounds/
        │   └── Train/
        ├── BackGrounds_raw/
        │   ├── Train/
        │   └── Val/
        ├── BreakableObjects/
        │   ├── Train/
        │   └── Val/
        ├── InteractableObjects/
        │   ├── Train/
        │   └── Val/
        ├── MaterialsAppearance/
        │   ├── Train/
        │   └── Val/
        ├── MaterialsPhysics/
        │   ├── Train/
        │   └── Val/
        ├── Scripts/
        │   └── MoviePipelinePrimaryConfig*.uasset
        ├── SolidObjects/
        │   ├── Train/
        │   └── Val/
        ├── Scenes/
        │   ├── Train/
        │   └── Val/
        └── Trajectories/
            ├── Train/
            └── Val/
```

The Movie Render Queue assets must remain in `Content/PhysInOne/Scripts/`,
which Unreal Engine exposes as `/Game/PhysInOne/Scripts/`. The public rendering
tools refer to that package path directly.

Do not rename or flatten `BackGrounds_raw`, `__ExternalActors__`, or
`__ExternalObjects__`. Unreal Engine resolves assets by project-relative
package paths.

## Resume and logs

Re-run the same command with the same output directory. Completed downloads are
reused, `.part` files resume, and archives with valid completion markers are
skipped.

Logs are written to:

```text
<output-dir>/_download_logs/YYYYMMDD_HHMMSS/
├── downloads.tsv
├── extractions.tsv
├── failures.tsv
└── summary.json
```

For slower or rate-limited networks:

```bash
python scripts/download_data.py --task 3d-assets \
  --output-dir ./PhysInOne_data \
  --workers 2
```

Public downloads are anonymous. The downloader has no token parameter or
credential-handling path.

## Contact

For setup questions, contact Siyuan Zhou at
`siyuan.zhou@connect.polyu.hk`. WeChat: `aify20001009`.