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
 - Fan RPM
    - Current
    - Target

*Note:* Tested _only_ on `RX6000` series cards; more may be supported. Please file an issue if incompatibility is found!

## Requirements
Only `Linux` is supported. Information is _completely_ sourced from interfaces in `sysfs`.

It _may_ be necessary to update the `amdgpu.ppfeaturemask` parameter to enable metrics.

This is assumed present for *control* over the elements being monitored. Untested without. 

See [this Arch Wiki entry](https://wiki.archlinux.org/title/AMDGPU#Boot_parameter) for context.

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

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

## Screenshots

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

Log screen:
![Screenshot of log screen](screens/logging.png "Logging screen")
Only the statistic files and toggling Dark/Light mode are logged; metrics will be added with a configurable interval.
init 2023-04-21 05:42:38 +00:00			`# amdgpu_stats`

			`Simple TUI _(using [Textual](https://textual.textualize.io/))_ that shows AMD GPU statistics:`
add fan RPM: current/target 2023-04-21 22:45:40 +00:00			`- GPU Utilization`
			`- Temperature`
			`- Core clock`
			`- Core voltage`
			`- Memory clock`
			`- Power consumption`
			`- Power limits`
			`- Default`
			`- Configured`
			`- Board capability`
			`- Fan RPM`
			`- Current`
			`- Target`
init 2023-04-21 05:42:38 +00:00
shuffle requirements, consolidate Linux notes 2023-04-22 14:35:52 +00:00			Note: Tested _only_ on `RX6000` series cards; more may be supported. Please file an issue if incompatibility is found!
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`
clarity on Linux requirement/info source 2023-04-21 17:46:51 +00:00			Only `Linux` is supported. Information is _completely_ sourced from interfaces in `sysfs`.
clarify requirements 2023-04-21 17:39:34 +00:00
shuffle requirements, consolidate Linux notes 2023-04-22 14:35:52 +00:00			It _may_ be necessary to update the `amdgpu.ppfeaturemask` parameter to enable metrics.

			`This is assumed present for control over the elements being monitored. Untested without.`

			`See [this Arch Wiki entry](https://wiki.archlinux.org/title/AMDGPU#Boot_parameter) for context.`

clarify requirements 2023-04-21 17:39:34 +00:00			`### Python`
			`The Fedora base repositories provide the requirements with these packages:`
			- `python3-humanfriendly`
			- `python3-textual`

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

move requirements above screenshots 2023-04-21 15:48:50 +00:00			`## Screenshots`

			`Main screen:`
move screenshots to subdir 2023-04-21 23:54:52 +00:00			`![Screenshot of main screen](screens/main.png "Main screen")`
move requirements above screenshots 2023-04-21 15:48:50 +00:00
			`Log screen:`
move screenshots to subdir 2023-04-21 23:54:52 +00:00			`![Screenshot of log screen](screens/logging.png "Logging screen")`
note RE: logging 2023-04-21 22:55:09 +00:00			`Only the statistic files and toggling Dark/Light mode are logged; metrics will be added with a configurable interval.`