Metadata-Version: 2.4
Name: multimodalsim_viewer
Version: 0.1.1.0
Summary: Multimodal simulation viewer
Keywords: flask angular ui multimodal server
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: flask==3.1.1
Requires-Dist: flask-socketio==5.5.1
Requires-Dist: eventlet==0.40.0
Requires-Dist: websocket-client==1.8.0
Requires-Dist: filelock==3.18.0
Requires-Dist: flask_cors==6.0.0
Requires-Dist: questionary==2.1.0
Requires-Dist: python-dotenv==1.1.0
Requires-Dist: multimodalsim==0.0.1
Requires-Dist: get_latest_version==1.0.3
Requires-Dist: setuptools==80.9.0
Provides-Extra: dev
Requires-Dist: black==25.1.0; extra == "dev"
Requires-Dist: pylint==3.3.7; extra == "dev"
Requires-Dist: isort==6.0.1; extra == "dev"
Provides-Extra: build
Requires-Dist: build; extra == "build"
Requires-Dist: twine; extra == "build"
Dynamic: description
Dynamic: description-content-type
Dynamic: keywords
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# multimodalsim-viewer

This package provides an interface to the [multimodalsim simulation project](https://pypi.org/project/multimodalsim/), allowing you to run and visualize simulations easily through a web interface.

## Usage

You have access to several commands that will allow you to run the project easily. You can use the `--help` flag to see a list of available options.

```bash
viewer start 

viewer stop

viewer simulate
```

## `DataCollector`

The `SimulationVisualizationDataCollector` class is used to collect data from the simulation and visualize it. You can pass an instance of this class to the simulation to collect data during the simulation. This might be useful if you work on the multimodalsim package and want to visualize the simulation data in real-time.

## Input data

To run a simulation, you need to provide input data. You can upload input data folders through the web interface. Some basic input data folders are available [here](https://github.com/lab-core/multimodal-data). You can also clone the repository and use the data from there : 

```bash
git clone https://github.com/lab-core/multimodal-data.git
```

## Environment variables

Some environment variables are available to customize the application. You can find a detailed list of these variables in the [README.md](https://github.com/lab-core/multimodal-simulator/blob/main/README.md#environment-variables) file of the multimodal-simulator repository.
