amdgpu_stats/README.md

# amdgpu_stats

Simple TUI _(using [Textual](https://textual.textualize.io/))_ that shows AMD GPU statistics:
 - GPU Utilization
 - Temperature
 - Core clock
 - Core voltage
 - Memory clock
 - Power consumption
 - Power limits
   - Default
   - Configured
   - Board capability

*Note:* Tested _only_ on `RX6000` series cards -- will support more with help, please file an issue.

## Requirements
Only `Linux` is supported. Information heavily relies on the `hwmon` interfaces in `sysfs`.

### Python
The Fedora base repositories provide the requirements with these packages:
 - `python3-humanfriendly`
 - `python3-textual`

See [requirements.txt](requirements.txt) for other distributions

### Kernel
It _may_ be necessary to update the `amdgpu.ppfeaturemask` parameter to enable data collection. 

This is assumed for *control* over the elements being monitored. Untested without. See [this](https://wiki.archlinux.org/title/AMDGPU#Boot_parameter) for context

## Screenshots

Main screen:
![Screenshot of main screen](main.png "Main screen")

Log screen:
![Screenshot of log screen](logging.png "Logging screen")
init 2023-04-21 05:42:38 +00:00			`# amdgpu_stats`

			`Simple TUI _(using [Textual](https://textual.textualize.io/))_ that shows AMD GPU statistics:`
			`- GPU Utilization`
			`- Temperature`
			`- Core clock`
			`- Core voltage`
			`- Memory clock`
			`- Power consumption`
			`- Power limits`
			`- Default`
			`- Configured`
			`- Board capability`

add requirements.txt w/ tested versions 2023-04-21 16:57:37 +00:00			Note: Tested _only_ on `RX6000` series cards -- will support more with help, please file an issue.
add notes on requirements; pending packaging 2023-04-21 05:47:54 +00:00
add requirements.txt w/ tested versions 2023-04-21 16:57:37 +00:00			`## Requirements`
clarify requirements 2023-04-21 17:39:34 +00:00			Only `Linux` is supported. Information heavily relies on the `hwmon` interfaces in `sysfs`.

			`### Python`
			`The Fedora base repositories provide the requirements with these packages:`
			- `python3-humanfriendly`
			- `python3-textual`

			`See [requirements.txt](requirements.txt) for other distributions`

add requirements.txt w/ tested versions 2023-04-21 16:57:37 +00:00			`### Kernel`
note RE: kernel param 2023-04-21 15:48:02 +00:00			It _may_ be necessary to update the `amdgpu.ppfeaturemask` parameter to enable data collection.

add requirements.txt w/ tested versions 2023-04-21 16:57:37 +00:00			`This is assumed for control over the elements being monitored. Untested without. See [this](https://wiki.archlinux.org/title/AMDGPU#Boot_parameter) for context`
move requirements above screenshots 2023-04-21 15:48:50 +00:00
			`## Screenshots`

			`Main screen:`
			`![Screenshot of main screen](main.png "Main screen")`

			`Log screen:`
			`![Screenshot of log screen](logging.png "Logging screen")`