Dear RosNodeViewer
About
- Visualize ROS2 node diagram
- Support the following sources:
- architecture.yaml generated by CARET
- rosgraph.dot generated by rqt_graph
- running ROS graph analysis
Requirements
- Ubuntu 20.04 or 22.04
- graphviz is required
- optional: ROS 2 Galactic or Humble if you need runtime ROS graph analysis
- e.g.,
sudo apt install ros-humble-rqt-graph,sudo apt install ros-humble-desktop
- e.g.,
- Not tested in Windows / Mac
Get Started
# Install Dear RosNodeViewer
pipx install dear-ros-node-viewer --system-site-packages
# Download sample graph
wget https://raw.githubusercontent.com/iwatake2222/dear_ros_node_viewer/main/sample/architecture_autoware.yaml
# Run Dear RosNodeViewer
dear_ros_node_viewer architecture_autoware.yaml
- Quick operation guide:
- Middle button drag: move graph area
- Mouse scroll: zoom in/out (zoom function is tentative)
How to Use
Development
Setup
git clone https://github.com/iwatake2222/dear_ros_node_viewer.git
cd dear_ros_node_viewer
pip install -e .
pip install -r requirements.txt
Running Tests
# Run all tests
pytest tests/ -v
# Run with coverage
pytest --doctest-modules -v --cov=./src/dear_ros_node_viewer
# Run single test file
pytest tests/test_caret2networkx.py -v
Linting
flake8 . --exclude=.venv --count --select=E9,F63,F7,F82 --show-source --statistics
pylint ./src/dear_ros_node_viewer --disable=E0401,W1203,C0301
Acknowledgements
- Dear RosNodeViewer utilizes Dear PyGui
- Dear RosNodeViewer is named in honor of Dear PyGui
- Dear RosNodeViewer contains Roboto font
- licensed under the Apache License, Version 2.0.
2 maintainers
Metadata
2 maintainers
Release files for dear-ros-node-viewer 1.1.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| dear_ros_node_viewer-1.1.5.tar.gz | 264.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| dear_ros_node_viewer-1.1.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 391.1 kB
Release files / dear_ros_node_viewer-1.1.5.tar.gz
| Download URL | dear_ros_node_viewer-1.1.5.tar.gz |
|---|---|
| Size | 264.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
944c5594939cea4e8119dbe0df2b4a1468c4ea6c4e3bf608a262159010998c8b
|
|
BLAKE2b-256 checksum How to use checksums |
c2042e2a3dff302c75bf8fbb4827110c2ef89d6361331aaf1428e1df6e366076
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Release files / dear_ros_node_viewer-1.1.5-py3-none-any.whl
| Download URL | dear_ros_node_viewer-1.1.5-py3-none-any.whl |
|---|---|
| Size | 127.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
486aac847abb79cfea590c151143f64e15a0717362d00e707a23fd723278e192
|
|
BLAKE2b-256 checksum How to use checksums |
5ce4d813b7b2ee223e98b9ed447c4873e07dc0a6da54064d8c1927a893b9514d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
