amdgpu_stats/README.md

# amdgpu_stats

Simple TUI _(using [Textual](https://textual.textualize.io/))_ that shows AMD GPU statistics

- GPU Utilization
- Temperatures _(as applicable)_
    - Edge
    - Junction
    - Memory
- Core clock
- Core voltage
- Memory clock
- Power consumption
- Power limits
    - Default
    - Configured
    - Board capability
 - Fan RPM
    - Current
    - Target

Main screen:
![Screenshot of main screen](https://raw.githubusercontent.com/joshlay/amdgpu_stats/master/screens/main.png "Main screen")

Log screen:
![Screenshot of log screen](https://raw.githubusercontent.com/joshlay/amdgpu_stats/master/screens/logging.png "Logging screen")

Statistics are not logged; only toggling Dark/light mode and the stat names / source files.

Tested _only_ on `RX6000` series cards; more may be supported. Please file an issue if finding incompatibility!

## 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
init 2023-04-21 05:42:38 +00:00			`# amdgpu_stats`

rearrange 2023-04-23 16:07:06 +00:00			`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`
add dynamic (context aware) temperature sources 2023-04-22 17:56:09 +00:00			`- Temperatures _(as applicable)_`
			`- Edge`
			`- Junction`
			`- Memory`
add fan RPM: current/target 2023-04-21 22:45:40 +00:00			`- 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
rearrange 2023-04-23 16:07:06 +00:00			`Main screen:`
cut new release with absolute URLs for PyPi screenshots 2023-04-23 22:20:46 +00:00			`![Screenshot of main screen](https://raw.githubusercontent.com/joshlay/amdgpu_stats/master/screens/main.png "Main screen")`
rearrange 2023-04-23 16:07:06 +00:00
			`Log screen:`
cut new release with absolute URLs for PyPi screenshots 2023-04-23 22:20:46 +00:00			`![Screenshot of log screen](https://raw.githubusercontent.com/joshlay/amdgpu_stats/master/screens/logging.png "Logging screen")`
rearrange 2023-04-23 16:07:06 +00:00
			`Statistics are not logged; only toggling Dark/light mode and the stat names / source files.`

shorten note, attempt to fit on one line 2023-04-22 14:37:54 +00:00			Tested _only_ on `RX6000` series cards; more may be supported. Please file an issue if finding incompatibility!
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`