# GPU Monitor (`gpumon`)
`gpumon` is a real-time GPU monitoring tool designed to display various metrics for NVIDIA GPUs, including temperature, fan speed, memory usage, load, and power consumption. It provides color-coded output for easy identification of critical values and can operate in both continuous and one-time monitoring modes.
## Features
- **Real-time Monitoring**: Continuously monitors NVIDIA GPU statistics.
- **Detailed Metrics**: Displays temperature, fan speed, memory usage, GPU load, and power consumption.
- **Color-Coded Output**: Highlights different levels of each metric with distinct colors for easy visualization.
- **Customizable**: Users can adjust the bar length and refresh rate.
- **Single or Continuous Mode**: Option to display GPU status once or continuously update.
## Installation
### Prerequisites
- **Python 3.x**
- **NVIDIA drivers**
- **`nvidia-smi` command-line utility**
### Install using pip
To install `gpumon`, use the following command:
```bash
pip install gpumon
```
## Usage
Run the tool using the command line:
### Continuous Monitoring (default mode)
```bash
gpumon
```
This command will start `gpumon` in continuous monitoring mode, refreshing the display every 0.5 seconds.
### One-Time Status Display
To display the GPU status once and then exit:
```bash
gpumon --continuous False
```
### Custom Bar Length and Refresh Rate
You can customize the appearance and behavior of the monitoring display:
```bash
gpumon --bar-length 5 --refresh-rate 1.0
```
- `--bar-length`: Sets the length of the progress bars (default is 5).
- `--refresh-rate`: Sets the refresh rate in seconds (default is 0.5 seconds).
### Command-Line Arguments
- `--bar-length`: The length of the progress bars. This controls how much detail is displayed in the bar representation.
- `--refresh-rate`: The rate in seconds at which the display refreshes.
- `--continuous`: Set to `False` for a one-time status display, otherwise the tool runs continuously (default is `True`).
## Example Output
```
[0]-NVIDIA A100 Fan: 70% Power: 250.00 W Temp: 72C [███░░] Load: 90% [███░░] Mem: 80000/80000 MB [██████] Freq: 1500/2100 MHz [███░░]
[1]-NVIDIA A100 Fan: 75% Power: 245.00 W Temp: 73C [███░░] Load: 85% [███░░] Mem: 78000/80000 MB [██████] Freq: 1550/2100 MHz [███░░]
[2]-NVIDIA A100 Fan: 65% Power: 260.00 W Temp: 70C [███░░] Load: 80% [███░░] Mem: 77000/80000 MB [██████] Freq: 1600/2100 MHz [███░░]
[3]-NVIDIA A100 Fan: 68% Power: 255.00 W Temp: 71C [███░░] Load: 75% [███░░] Mem: 76000/80000 MB [██████] Freq: 1650/2100 MHz [███░░]
[4]-NVIDIA A100 Fan: 72% Power: 240.00 W Temp: 74C [███░░] Load: 95% [███░░] Mem: 80000/80000 MB [██████] Freq: 1700/2100 MHz [███░░]
[5]-NVIDIA A100 Fan: 60% Power: 250.00 W Temp: 72C [███░░] Load: 85% [███░░] Mem: 79000/80000 MB [██████] Freq: 1500/2100 MHz [███░░]
[6]-NVIDIA A100 Fan: 70% Power: 250.00 W Temp: 72C [███░░] Load: 90% [███░░] Mem: 80000/80000 MB [██████] Freq: 1500/2100 MHz [███░░]
[7]-NVIDIA A100 Fan: 70% Power: 250.00 W Temp: 72C [███░░] Load: 90% [███░░] Mem: 80000/80000 MB [██████] Freq: 1500/2100 MHz [███░░]
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
---
### Notes
- Ensure that the `nvidia-smi` tool is available on your system, as `gpumon` relies on it to gather GPU metrics.
Raw data
{
"_id": null,
"home_page": "https://github.com/abdkhanstd/GpuMonitor",
"name": "gpumon",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "ABD",
"author_email": "abdkhan@163.com",
"download_url": null,
"platform": null,
"description": "# GPU Monitor (`gpumon`)\n\n`gpumon` is a real-time GPU monitoring tool designed to display various metrics for NVIDIA GPUs, including temperature, fan speed, memory usage, load, and power consumption. It provides color-coded output for easy identification of critical values and can operate in both continuous and one-time monitoring modes.\n\n## Features\n\n- **Real-time Monitoring**: Continuously monitors NVIDIA GPU statistics.\n- **Detailed Metrics**: Displays temperature, fan speed, memory usage, GPU load, and power consumption.\n- **Color-Coded Output**: Highlights different levels of each metric with distinct colors for easy visualization.\n- **Customizable**: Users can adjust the bar length and refresh rate.\n- **Single or Continuous Mode**: Option to display GPU status once or continuously update.\n\n## Installation\n\n### Prerequisites\n\n- **Python 3.x**\n- **NVIDIA drivers**\n- **`nvidia-smi` command-line utility**\n\n### Install using pip\n\nTo install `gpumon`, use the following command:\n\n```bash\npip install gpumon\n```\n\n## Usage\n\nRun the tool using the command line:\n\n### Continuous Monitoring (default mode)\n\n```bash\ngpumon\n```\n\nThis command will start `gpumon` in continuous monitoring mode, refreshing the display every 0.5 seconds.\n\n### One-Time Status Display\n\nTo display the GPU status once and then exit:\n\n```bash\ngpumon --continuous False\n```\n\n### Custom Bar Length and Refresh Rate\n\nYou can customize the appearance and behavior of the monitoring display:\n\n```bash\ngpumon --bar-length 5 --refresh-rate 1.0\n```\n\n- `--bar-length`: Sets the length of the progress bars (default is 5).\n- `--refresh-rate`: Sets the refresh rate in seconds (default is 0.5 seconds).\n\n### Command-Line Arguments\n\n- `--bar-length`: The length of the progress bars. This controls how much detail is displayed in the bar representation.\n- `--refresh-rate`: The rate in seconds at which the display refreshes.\n- `--continuous`: Set to `False` for a one-time status display, otherwise the tool runs continuously (default is `True`).\n\n## Example Output\n\n```\n[0]-NVIDIA A100 Fan: 70% Power: 250.00 W Temp: 72C [\u2588\u2588\u2588\u2591\u2591] Load: 90% [\u2588\u2588\u2588\u2591\u2591] Mem: 80000/80000 MB [\u2588\u2588\u2588\u2588\u2588\u2588] Freq: 1500/2100 MHz [\u2588\u2588\u2588\u2591\u2591]\n[1]-NVIDIA A100 Fan: 75% Power: 245.00 W Temp: 73C [\u2588\u2588\u2588\u2591\u2591] Load: 85% [\u2588\u2588\u2588\u2591\u2591] Mem: 78000/80000 MB [\u2588\u2588\u2588\u2588\u2588\u2588] Freq: 1550/2100 MHz [\u2588\u2588\u2588\u2591\u2591]\n[2]-NVIDIA A100 Fan: 65% Power: 260.00 W Temp: 70C [\u2588\u2588\u2588\u2591\u2591] Load: 80% [\u2588\u2588\u2588\u2591\u2591] Mem: 77000/80000 MB [\u2588\u2588\u2588\u2588\u2588\u2588] Freq: 1600/2100 MHz [\u2588\u2588\u2588\u2591\u2591]\n[3]-NVIDIA A100 Fan: 68% Power: 255.00 W Temp: 71C [\u2588\u2588\u2588\u2591\u2591] Load: 75% [\u2588\u2588\u2588\u2591\u2591] Mem: 76000/80000 MB [\u2588\u2588\u2588\u2588\u2588\u2588] Freq: 1650/2100 MHz [\u2588\u2588\u2588\u2591\u2591]\n[4]-NVIDIA A100 Fan: 72% Power: 240.00 W Temp: 74C [\u2588\u2588\u2588\u2591\u2591] Load: 95% [\u2588\u2588\u2588\u2591\u2591] Mem: 80000/80000 MB [\u2588\u2588\u2588\u2588\u2588\u2588] Freq: 1700/2100 MHz [\u2588\u2588\u2588\u2591\u2591]\n[5]-NVIDIA A100 Fan: 60% Power: 250.00 W Temp: 72C [\u2588\u2588\u2588\u2591\u2591] Load: 85% [\u2588\u2588\u2588\u2591\u2591] Mem: 79000/80000 MB [\u2588\u2588\u2588\u2588\u2588\u2588] Freq: 1500/2100 MHz [\u2588\u2588\u2588\u2591\u2591]\n[6]-NVIDIA A100 Fan: 70% Power: 250.00 W Temp: 72C [\u2588\u2588\u2588\u2591\u2591] Load: 90% [\u2588\u2588\u2588\u2591\u2591] Mem: 80000/80000 MB [\u2588\u2588\u2588\u2588\u2588\u2588] Freq: 1500/2100 MHz [\u2588\u2588\u2588\u2591\u2591]\n[7]-NVIDIA A100 Fan: 70% Power: 250.00 W Temp: 72C [\u2588\u2588\u2588\u2591\u2591] Load: 90% [\u2588\u2588\u2588\u2591\u2591] Mem: 80000/80000 MB [\u2588\u2588\u2588\u2588\u2588\u2588] Freq: 1500/2100 MHz [\u2588\u2588\u2588\u2591\u2591]\n```\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n---\n\n### Notes\n\n- Ensure that the `nvidia-smi` tool is available on your system, as `gpumon` relies on it to gather GPU metrics.\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A simple GPU monitoring tool.",
"version": "0.0.11",
"project_urls": {
"Homepage": "https://github.com/abdkhanstd/GpuMonitor"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4e0fd81b46d83553bdd2f7510c8c5eaf927f27ae523444b7507fe02ba2b5101c",
"md5": "0b556f775cef8d33ad59285e54bebd93",
"sha256": "d6af49e79f749c9a4c0d17256e3d5fe511c270039d3773ec46da1f5531c4505f"
},
"downloads": -1,
"filename": "gpumon-0.0.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0b556f775cef8d33ad59285e54bebd93",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 7063,
"upload_time": "2024-09-02T09:39:48",
"upload_time_iso_8601": "2024-09-02T09:39:48.408710Z",
"url": "https://files.pythonhosted.org/packages/4e/0f/d81b46d83553bdd2f7510c8c5eaf927f27ae523444b7507fe02ba2b5101c/gpumon-0.0.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-02 09:39:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "abdkhanstd",
"github_project": "GpuMonitor",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "gpumon"
}
JSON
