plume-python 1.3.2

Set of utilities to work with PLM record files.

Charles Javerliat, Sophie Villenave, Pierre Raimbaud, Guillaume Lavoué
IEEE Conference on Virtual Reality and 3D User Interfaces (Journal Track)
Video »  Paper »  Explore the docs »

PLUME Python is a Python package that allows you to load and extract data from PLUME record files. The package also comes with a set of utilities to simplify the conversion of the data into more commonly used formats in data analysis like pandas dataframe or CSV files. Embedded data such as LabStreamingLayer's samples can be exported to XDF files for external use in tools such as SigViewer, EEGLAB or MoBILAB.

Getting Started

PLUME Python can be installed directly from PyPI (requires Python >= 3.10) using the following command:

pip install plume-python

Please refer to the getting started guide for information on getting started with PLUME-Python.

Documentation

The full documentation is available at liris-xr.github.io/PLUME/. It includes a detailed description of the installation process, the file format specifications, the usage of the different tools, etc.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. You can open an issue to report a bug, request a feature, or submit a pull request.

Development setup

Use the following commands to install the package in dev mode and run tests:

# Install the package with dev dependencies
make install
# Running tests locally with pytest
make tests

Contact

Discord server (Recommended)

Charles JAVERLIAT - [e-mail]

Sophie VILLENAVE - [e-mail]

Citation

@article{javerliat_plume_2024,
	title = {{PLUME}: {Record}, {Replay}, {Analyze} and {Share} {User} {Behavior} in {6DoF} {XR} {Experiences}},
	url = {https://ieeexplore.ieee.org/document/10458415},
	doi = {10.1109/TVCG.2024.3372107},
	journal = {IEEE Transactions on Visualization and Computer Graphics},
	author = {Javerliat, Charles and Villenave, Sophie and Raimbaud, Pierre and Lavoué, Guillaume},
	year = {2024},
	note = {Conference Name: IEEE Transactions on Visualization and Computer Graphics},
	pages = {1--11}
}