Metadata-Version: 2.4
Name: rscope
Version: 0.0.2
Summary: RL training visualizer for Mujoco Playground environments + Brax training
Project-URL: Homepage, https://github.com/Andrew-Luo1/rscope
Author-email: Jing Yuan Luo <andrew.luo1@outlook.com>
License-Expression: MIT
License-File: LICENSE
Keywords: brax,mujoco,reinforcement learning,visualization
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.10
Requires-Dist: brax
Requires-Dist: jax
Requires-Dist: mujoco
Requires-Dist: numpy
Requires-Dist: paramiko
Requires-Dist: watchdog
Provides-Extra: all
Requires-Dist: absl-py; extra == 'all'
Requires-Dist: mypy; extra == 'all'
Requires-Dist: pre-commit; extra == 'all'
Requires-Dist: pyink; extra == 'all'
Requires-Dist: pytest; extra == 'all'
Requires-Dist: pytest-xdist; extra == 'all'
Requires-Dist: pytype; extra == 'all'
Provides-Extra: dev
Requires-Dist: absl-py; extra == 'dev'
Requires-Dist: mypy; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: pyink; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-xdist; extra == 'dev'
Requires-Dist: pytype; extra == 'dev'
Provides-Extra: test
Requires-Dist: absl-py; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-xdist; extra == 'test'
Description-Content-Type: text/markdown

# rscope
RL training visualizer for Mujoco Playground environments + Brax training

## Usage

### Local Mode
To visualize locally stored rollouts:
```bash
python -m rscope
```

### SSH Mode
To visualize rollouts stored on a remote server via SSH:
```bash
python -m rscope --ssh-to username@hostname[:port] --ssh-key ~/path/to/private_key
```

### Options
- `--ssh-to`: SSH connection string in the format `username@host[:port]`
- `--ssh-key`: Path to SSH private key file (required when using `--ssh-to`)
- `--polling-interval`: Interval in seconds for SSH file polling (default: 10)

## Notes
- When using SSH mode, the `--ssh-key` parameter is required
- The default SSH port (22) is used if not specified in the `--ssh-to` string
