# 🤖 robot-log-visualizer
`robot-log-visualizer` implements a python visualizer to display the data logged with
[`YarpRobotLoggerDevice`](https://github.com/ami-iit/bipedal-locomotion-framework/tree/master/devices/YarpRobotLoggerDevice) application.
## 📝 Install
Please follow one of the following methods to use the software
### <img src="https://github.com/ami-iit/robot-log-visualizer/assets/16744101/8de4bc21-26be-4ec5-a262-6179b53ef082" width="22" height="22"/> Install with `conda` (recommended)
Assuming that you have [`conda`](https://docs.conda.io/en/latest/) installed, you can create a new environment and install the `robot-log-visualizer` with the following commands:
```console
conda create -n visualizer-env
conda activate visualizer-env
```
and you can install the `robot-log-visualizer` with the following command
```console
conda install -c robotology robot-log-visualizer
```
### 🐍 Install from `pip` with apt python
Install `python3`, if not installed (in **Ubuntu 20.04**):
```console
sudo apt install python3.8 python3-virtualenv swig
```
Create a [virtual environment](https://docs.python.org/3/library/venv.html#venv-def) and activate it. For example:
```console
python3 -m venv visualizer-env
. visualizer-env/bin/activate
```
Inside the virtual environment, install the application from `pip`:
```console
pip install robot-log-visualizer
```
### 👷 Install the latest version (not recommended)
If you want to use the latest feature of the `robot-log-visualizer` you can install it with the
following command
```console
python -m pip install git+https://github.com/ami-iit/robot-log-visualizer.git
```
## 🏃 Usage
Once you have installed the `robot-log-visualizer` you can run it from the terminal
[robot-log-visualizer.webm](https://github.com/ami-iit/robot-log-visualizer/assets/16744101/3fd5c516-da17-4efa-b83b-392b5ce1383b)
You can navigate the dataset thanks to the slider or by pressing `Ctrl-f` and `Ctrl-b` to move
forward and backward.
### 💡 Environment variables
`robot-log-visualizer` looks for the model in the folders pointed by one of the following environment variables:
`GAZEBO_MODEL_PATH`, `ROS_PACKAGE_PATH`, `AMENT_PREFIX_PATH` Please remember to add your model folder to one of these
environment variables.
For instance, if you have a model in the folder `~/my-models` you can add it to the `GAZEBO_MODEL_PATH` with the
following command
```console
export GAZEBO_MODEL_PATH=${GAZEBO_MODEL_PATH}:~/my-models
```
Where `~/my-models` is the path to your models folder that is structured as follows
```console
tree ~/my-models
~/my-models
├── model1
│ ├── model.config
│ └── model.urdf
└── model2
├── model.config
└── model.urdf
```
And the name of the robot stored in the `mat` file is `model1` or `model2`.
## 🐛 Bug reports and support
All types of [issues](https://github.com/ami-iit/robot-log-visualizer/issues/new) are welcome.
## 📝 License
Materials in this repository are distributed under the following license:
> All software is licensed under the BSD 3-Clause License. See [LICENSE](https://github.com/ami-iit/robot-log-visualizer/blob/main/LICENSE) file for details.
## 🧑💻 Maintainers
* Giulio Romualdi ([@GiulioRomualdi](https://github.com/GiulioRomualdi))
* Paolo Viceconte ([@paolo-viceconte](https://github.com/paolo-viceconte))
Raw data
{
"_id": null,
"home_page": "https://github.com/ami-iit/robot-log-visualizer",
"name": "robot-log-visualizer",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "robotics,visualization",
"author": "Giulio Romualdi",
"author_email": "giulio.romualdi@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ed/39/77572cd43829bbbc54bf29e7ab0fe53fbf89eaa23e4d1125cd3bb8a6bb94/robot-log-visualizer-0.7.0.tar.gz",
"platform": "any",
"description": "# \ud83e\udd16 robot-log-visualizer\n\n`robot-log-visualizer` implements a python visualizer to display the data logged with\n[`YarpRobotLoggerDevice`](https://github.com/ami-iit/bipedal-locomotion-framework/tree/master/devices/YarpRobotLoggerDevice) application.\n\n## \ud83d\udcdd Install\n\nPlease follow one of the following methods to use the software\n\n### <img src=\"https://github.com/ami-iit/robot-log-visualizer/assets/16744101/8de4bc21-26be-4ec5-a262-6179b53ef082\" width=\"22\" height=\"22\"/> Install with `conda` (recommended)\n\nAssuming that you have [`conda`](https://docs.conda.io/en/latest/) installed, you can create a new environment and install the `robot-log-visualizer` with the following commands:\n```console\nconda create -n visualizer-env\nconda activate visualizer-env\n```\n and you can install the `robot-log-visualizer` with the following command\n```console\nconda install -c robotology robot-log-visualizer\n```\n\n### \ud83d\udc0d Install from `pip` with apt python\n\nInstall `python3`, if not installed (in **Ubuntu 20.04**):\n\n```console\nsudo apt install python3.8 python3-virtualenv swig\n```\n\nCreate a [virtual environment](https://docs.python.org/3/library/venv.html#venv-def) and activate it. For example:\n```console\npython3 -m venv visualizer-env\n. visualizer-env/bin/activate\n```\n\nInside the virtual environment, install the application from `pip`:\n\n```console\npip install robot-log-visualizer\n```\n\n### \ud83d\udc77 Install the latest version (not recommended)\nIf you want to use the latest feature of the `robot-log-visualizer` you can install it with the\nfollowing command\n```console\npython -m pip install git+https://github.com/ami-iit/robot-log-visualizer.git\n```\n\n## \ud83c\udfc3 Usage\n\nOnce you have installed the `robot-log-visualizer` you can run it from the terminal\n\n[robot-log-visualizer.webm](https://github.com/ami-iit/robot-log-visualizer/assets/16744101/3fd5c516-da17-4efa-b83b-392b5ce1383b)\n\nYou can navigate the dataset thanks to the slider or by pressing `Ctrl-f` and `Ctrl-b` to move\nforward and backward.\n\n### \ud83d\udca1 Environment variables\n`robot-log-visualizer` looks for the model in the folders pointed by one of the following environment variables:\n`GAZEBO_MODEL_PATH`, `ROS_PACKAGE_PATH`, `AMENT_PREFIX_PATH` Please remember to add your model folder to one of these\nenvironment variables.\nFor instance, if you have a model in the folder `~/my-models` you can add it to the `GAZEBO_MODEL_PATH` with the\nfollowing command\n```console\nexport GAZEBO_MODEL_PATH=${GAZEBO_MODEL_PATH}:~/my-models\n ```\nWhere `~/my-models` is the path to your models folder that is structured as follows\n```console\ntree ~/my-models\n~/my-models\n\u251c\u2500\u2500 model1\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 model.config\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 model.urdf\n\u2514\u2500\u2500 model2\n \u251c\u2500\u2500 model.config\n \u2514\u2500\u2500 model.urdf\n```\nAnd the name of the robot stored in the `mat` file is `model1` or `model2`.\n\n## \ud83d\udc1b Bug reports and support\nAll types of [issues](https://github.com/ami-iit/robot-log-visualizer/issues/new) are welcome.\n\n## \ud83d\udcdd License\nMaterials in this repository are distributed under the following license:\n\n> All software is licensed under the BSD 3-Clause License. See [LICENSE](https://github.com/ami-iit/robot-log-visualizer/blob/main/LICENSE) file for details.\n\n## \ud83e\uddd1\u200d\ud83d\udcbb Maintainers\n\n* Giulio Romualdi ([@GiulioRomualdi](https://github.com/GiulioRomualdi))\n* Paolo Viceconte ([@paolo-viceconte](https://github.com/paolo-viceconte))\n",
"bugtrack_url": null,
"license": "BSD3",
"summary": "Visualizer for robot logger",
"version": "0.7.0",
"project_urls": {
"Changelog": "https://github.com/ami-iit/robot-log-visualizer/releases",
"Homepage": "https://github.com/ami-iit/robot-log-visualizer",
"Source": "https://github.com/ami-iit/robot-log-visualizer",
"Tracker": "https://github.com/ami-iit/robot-log-visualizer/issues"
},
"split_keywords": [
"robotics",
"visualization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8a834663dd91db7f992ef22e94c74dfd3524aa323e4c3b9efde40d9210b8d70e",
"md5": "a2d102dffc317a6a59148cf41208abf6",
"sha256": "a148430dc809d55853922ef202d01bbfe486b4ab887a6880366ccb016803b6df"
},
"downloads": -1,
"filename": "robot_log_visualizer-0.7.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a2d102dffc317a6a59148cf41208abf6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 114661,
"upload_time": "2023-10-09T09:28:10",
"upload_time_iso_8601": "2023-10-09T09:28:10.922045Z",
"url": "https://files.pythonhosted.org/packages/8a/83/4663dd91db7f992ef22e94c74dfd3524aa323e4c3b9efde40d9210b8d70e/robot_log_visualizer-0.7.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ed3977572cd43829bbbc54bf29e7ab0fe53fbf89eaa23e4d1125cd3bb8a6bb94",
"md5": "489007f6d769c148850d7c561013000a",
"sha256": "0ce357bb54a50a69071231c43d0509b099c9a1d37c67ee7b8392d9b2dc0e92e7"
},
"downloads": -1,
"filename": "robot-log-visualizer-0.7.0.tar.gz",
"has_sig": false,
"md5_digest": "489007f6d769c148850d7c561013000a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 112932,
"upload_time": "2023-10-09T09:28:12",
"upload_time_iso_8601": "2023-10-09T09:28:12.479554Z",
"url": "https://files.pythonhosted.org/packages/ed/39/77572cd43829bbbc54bf29e7ab0fe53fbf89eaa23e4d1125cd3bb8a6bb94/robot-log-visualizer-0.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-09 09:28:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ami-iit",
"github_project": "robot-log-visualizer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "robot-log-visualizer"
}
JSON
