Update README.md

README.md

@@ -8,4 +8,69 @@ tags:
 - AR user motions
 - motions
 pretty_name: XR Motion Dataset Catalogue
----
+---
+
+# XR Motion Dataset Catalogue
+
+## Overview
+
+The XR Motion Dataset Catalogue, accompanying our paper "Navigating the Kinematic Maze: A Comprehensive Guide to XR Motion Dataset Standards," standardizes and simplifies access to Extended Reality (XR) motion datasets. The catalogue represents our initiative to streamline the usage of kinematic data in XR research by aligning various datasets to a consistent format and structure.
+
+### Dataset Specifications
+All datasets in this catalogue have been standardized with the following specifications:
+- **Coordinate System:** X (Right), Y (Up), Z (Forward)
+- **Rotation Representation:** Quaternions
+- **Units of Measurement:** Centimeters for spatial data
+- **Time Encoding:** Milliseconds for time-related data
+
+These specifications ensure uniformity and comparability across all datasets in the catalogue.
+
+### Conversion Scripts Repository
+The alignment of datasets was facilitated by a series of conversion scripts, which are available in our GitHub repository: [XR Motion Dataset Conversion Scripts](https://github.com/cschell/xr-motion-dataset-conversion-scripts). These scripts detail the process of aligning attribute names, coordinate systems, rotation representations, units of measurement, and time encoding.
+
+### Included Datasets
+The catalogue includes the following datasets:
+1. [LiebersBeatSaber23](https://doi.org/10.1145/3611659.3615696)
+2. [Boxrr23](https://doi.org/10.25350/B5NP4V) – *currently, only a small subset is available*
+3. [LiebersHand22](https://doi.org/10.1080/10447318.2022.2120845)
+4. [LiebersLabStudy21](https://doi.org/10.1145/3411764.3445528)
+5. [MooreCrossDomain23](https://doi.org/10.1109/ISMAR59233.2023.00054)
+6. <del>[RMillerBall22](https://github.com/Terascale-All-sensing-Research-Studio/VR-Biometric-Authentication)</del> *request for permissions pending*
+7. [VrNet](http://arxiv.org/abs/2306.03381)
+8. [WhoIsAlyx](https://doi.org/10.3389/frvir.2023.1272234)
+
+## Installation and Usage
+
+### Loading the Dataset with Hugging Face `datasets` Library
+To load a dataset from the catalogue, use the `datasets` library in Python. For example, to load the `WhoIsAlyx` dataset:
+
+```python
+from datasets import load_dataset
+
+dataset = load_dataset("cschell/xr-motion-dataset-catalogue", "who_is_alyx", trust_remote_code=True)
+```
+
+### Loading Individual Recordings with Pandas
+To load individual recordings, you can use `pandas`. Here's an example:
+
+```python
+import pandas as pd
+
+file_url_path = "hf://datasets/cschell/xr-motion-dataset-catalogue/who_is_alyx/player_02/2022-01-07.parquet"
+recording = pd.read_parquet(file_url_path)
+```
+
+## Contributing and Feedback
+Contributions and feedback are welcome to enhance the XR Motion Dataset Catalogue. Feel free to open a pull request or contact us directly.
+<!-- 
+## Citation
+If you use the XR Motion Dataset Catalogue in your research, please cite our paper:
+
+```
+@article{your_paper_identifier,
+  title={Navigating the Kinematic Maze: A Comprehensive Guide to XR Motion Dataset Standards},
+  author={Your Name and Other Authors},
+  journal={Journal Name},
+  year={Year}
+}
+``` -->