# 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.
```bash
viewer start
viewer start --ui # only start the UI side
viewer start --server # only start the server
viewer stop
viewer stop --ui # only stop the UI side
viewer stop --server # only stop the server
```
You can also run a simulation from the command line. This is useful for debugging, when you want to run a simulation without the web interface, and also for running simulations that uses a different version of the multimodalsim package.
Several arguments are available to customize the simulation and can be found with the --help option, but the required arguments will be asked interactively if not provided. The command to run a simulation is:
```bash
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
```
Raw data
{
"_id": null,
"home_page": null,
"name": "multimodalsim-viewer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "flask angular ui multimodal server",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/45/9d/09d88b2d026401169496d53b78729998da54fbfb72ad434b377b417de9ba/multimodalsim_viewer-0.0.2.tar.gz",
"platform": null,
"description": "# multimodalsim-viewer\n\nThis 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.\n\n## Usage\n\nYou have access to several commands that will allow you to run the project easily.\n\n```bash\nviewer start \nviewer start --ui # only start the UI side\nviewer start --server # only start the server \n\nviewer stop\nviewer stop --ui # only stop the UI side\nviewer stop --server # only stop the server\n```\n\nYou can also run a simulation from the command line. This is useful for debugging, when you want to run a simulation without the web interface, and also for running simulations that uses a different version of the multimodalsim package.\n\nSeveral arguments are available to customize the simulation and can be found with the --help option, but the required arguments will be asked interactively if not provided. The command to run a simulation is:\n\n```bash\nviewer simulate\n```\n\n## `DataCollector`\n\nThe `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.\n\n## Input data\n\nTo 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 : \n\n```bash\ngit clone https://github.com/lab-core/multimodal-data.git\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Multimodal simulation viewer",
"version": "0.0.2",
"project_urls": null,
"split_keywords": [
"flask",
"angular",
"ui",
"multimodal",
"server"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "a28438331279fccaa0b00d6c9f59f8904949543c555af7e550714a4831f6b2d3",
"md5": "e2b81e92a5b0814d35d74721e2bfdaa6",
"sha256": "d2538353c577c26f9ac2183b38d3f4427bbe337639e45f8cdb1d43a71c76f8a7"
},
"downloads": -1,
"filename": "multimodalsim_viewer-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e2b81e92a5b0814d35d74721e2bfdaa6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 1548715,
"upload_time": "2025-07-08T18:45:34",
"upload_time_iso_8601": "2025-07-08T18:45:34.667379Z",
"url": "https://files.pythonhosted.org/packages/a2/84/38331279fccaa0b00d6c9f59f8904949543c555af7e550714a4831f6b2d3/multimodalsim_viewer-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "459d09d88b2d026401169496d53b78729998da54fbfb72ad434b377b417de9ba",
"md5": "9a5428145114e2bb236dc789932a89cc",
"sha256": "f4f9c38f25d69242c4eea8437fd4d285e6a83117b275b18373583e7a4d2a9d54"
},
"downloads": -1,
"filename": "multimodalsim_viewer-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "9a5428145114e2bb236dc789932a89cc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 1541054,
"upload_time": "2025-07-08T18:45:35",
"upload_time_iso_8601": "2025-07-08T18:45:35.982223Z",
"url": "https://files.pythonhosted.org/packages/45/9d/09d88b2d026401169496d53b78729998da54fbfb72ad434b377b417de9ba/multimodalsim_viewer-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-08 18:45:35",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "multimodalsim-viewer"
}
JSON