leinardi/gwe


System utility designed to provide information, control the fans and overclock your NVIDIA card

Keywords: linux, nvidia, overclock


GreenWithEnvy (GWE)

GWE is a GTK system utility designed to provide information, control the fans and overclock your NVIDIA video card and graphics processor.

๐Ÿ’ก Features

  • Show general GPU stats (model name, driver version, gpu/memory/power usage, clocks, temps, etc)
  • GPU and Memory overclock offset profiles
  • Custom Fan curve profiles
  • Change power limit
  • Historical data graphs

๐Ÿ“ฆ How to get GWE

Install from Flathub

This is the preferred way to get GWE on any major distribution (Arch, Fedora, Linux Mint, openSUSE, Ubuntu, etc).

If you don't have Flatpak installed you can find step by step instructions here.

Make sure to have the Flathub remote added to the current user:

flatpak --user remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo

Install

flatpak --user install flathub com.leinardi.gwe
flatpak update # needed to be sure to have the latest org.freedesktop.Platform.GL.nvidia

Run

flatpak run com.leinardi.gwe

โš  Flatpak limitations

Beta Drivers

Currently Flatpak does not support Nvidia Beta drivers like 396.54.09 or 415.22.05.

Bumblebee and Optimus

Currently Flatpak does not support Bumblebee. If you want to use GWE with Bumblebee you need to install it from the source code.

Distro specific packages

Arch Linux

Install the gwe package from the AUR using your favourite helper, for example yay -S gwe.

Install from source code

Dependencies for (K/X)Ubuntu 18.10 or newer

sudo apt install git meson python3-pip python3-setuptools libcairo2-dev libgirepository1.0-dev libglib2.0-dev libdazzle-1.0-dev gir1.2-gtksource-3.0 gir1.2-appindicator3-0.1 python3-gi-cairo appstream-util

Dependencies for Fedora 28 or newer

dnf install desktop-file-utils git gobject-introspection-devel gtk3-devel libappstream-glib libdazzle libnotify meson python3-cairocffi python3-devel python3-pip redhat-rpm-config

Clone project and install

If you have not installed GWE yet:

git clone --recurse-submodules -j4 https://gitlab.com/leinardi/gwe.git
cd gwe
git checkout release
sudo -H pip3 install -r requirements.txt
meson . build --prefix /usr
ninja -v -C build
sudo ninja -v -C build install

Update old installation

If you installed GWE from source code previously and you want to update it:

cd gwe
git fetch
git checkout release
git reset --hard origin/release
git submodule init
git submodule update
sudo -H pip3 install -r requirements.txt
meson . build --prefix /usr
ninja -v -C build
sudo ninja -v -C build install

Run

Once installed, to start it you can simply execute on a terminal:

gwe

โš  Bumblebee and Optimus

If you want to use GWE with Bumblebee you need to start it with optirun and set the --ctrl-display parameter to :8:

optirun gwe --ctrl-display ":8"

โ„น๏ธ TODO

  • [x] Show general GPU info
  • [x] Show power info
  • [x] Show clocks info
  • [x] Show GPU temp in both app and app indicator
  • [x] Show fan info
  • [x] Allow to hide main app window
  • [x] Add command line option to start the app hidden
  • [x] Add Refresh timeout to settings
  • [x] Add command line option to add desktop entry
  • [x] About dialog
  • [x] Distributing with PyPI
  • [x] Show chart of selected fan profile
  • [x] Allow to select and apply a fan profile
  • [x] Add/Delete/Edit multi speed fan profiles (fan curve)
  • [x] Add option to restore last applied fan profile on app startup
  • [x] Find better icons for app indicator
  • [x] Try to lower resource consumption (mostly caused by nvidia-settings invocations)
  • [x] Show historical data of most important values in a separate dialog (requires GTK 3.24/GNOME 3.30)
  • [x] Add overclock profiles
  • [x] Add option to restore last applied overclock profile on app startup
  • [ ] Disable unsupported preferences
  • [x] Distributing with Flatpak
  • [x] Publishing on Flathub
  • [ ] Distributing with Snap
  • [ ] Check if NV-CONTROL is available and tell the user if is not
  • [ ] Add support for multi-GPU
  • [ ] Allow to select profiles from app indicator
  • [ ] Add support for i18n (internationalization and localization)

โŒจ๏ธ Command line options

Parameter Description Source Flatpak
-v, --version Show the app version x x
--debug Show debug messages x x
--hide-window Start with the main window hidden x x
--ctrl-display DISPLAY Specify the NV-CONTROL display x x
--application-entry Add a desktop entry for the application x
--autostart-on Enable automatic start of the app on login x
--autostart-off Disable automatic start of the app on login x

๐Ÿ–ฅ๏ธ Build, install and run with Flatpak

If you don't have Flatpak installed you can find step by step instructions here.

Make sure to have the Flathub remote added to the current user:

flatpak --user remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepoรน

Clone the repo

git clone --recurse-submodules -j4 https://gitlab.com/leinardi/gwe.git

It is possible to build the local source or the remote one (the same that Flathub uses)

Local repository

./build.sh --flatpak-local --flatpak-install

Remote repository

./build.sh --flatpak-remote --flatpak-install

Run

flatpak run com.leinardi.gwe --debug

๐Ÿ–ฅ๏ธ How to build and run the source code

If you want to clone the project and run directly from the source you need to manually install all the needed dependencies.

(K/X)Ubuntu 18.04 or newer

See Install from source

Fedora 28+ (outdated, please let me know if new dependencies are needed)

Install (K)StatusNotifierItem/AppIndicator Support

Arch Linux

The list of all the dependencies is available here: https://aur.archlinux.org/packages/gwe/

Python dependencies

git clone --recurse-submodules -j4 https://gitlab.com/leinardi/gwe.git
cd gwe
pip3 install -r requirements.txt

Build and Run

./run.sh

โ“ FAQ

I see some message about CoolBits in the Overclock/Fan profile section, what's that?

Coolbits was a Windows registry hack for Nvidia graphics cards Windows drivers, that allows tweaking features via the Nvidia driver control panel.
Something similar is available also on Linux and is the only way to enable Overclock and manual Fan control.
To know more about Coolbits and how to enable them click here (to enable both OC and Fan control you need to set it to 12).

The Flatpak version of GWE is not using my theme, how can I fix it?

Due to sandboxing, Flatpak applications use the default Gnome theme (Adwaita), and not whatever Gtk theme you're currently using.
The fix for this issue is to install your current Gtk theme from Flathub. This way, Flatpak applications will automatically pick the installed Gtk theme and use that instead of Adwaita.

Use this command to get a list of all the available Gtk themes on Flathub:

flatpak --user remote-ls flathub | grep org.gtk.Gtk3theme

And then just install your preferred theme. For example, to install Yaru:

flatpak install flathub org.gtk.Gtk3theme.Yaru

I have installed the app using Flatpak, but all the GWE fields are empty

This issue can be usually solved by closing GWE, executing flatpak update and starting GWE again. This is necessary to be sure to have the latest org.freedesktop.Platform.GL.nvidia. If, after the update, all the fields are still empty, feel free to open a new issue on the project tracker.

Why the memory overclock offsets effectively applied does not match the one set in the Nvidia Settings app?

Because Memory Transfer Rate, what Nvidia Settings reports and changes, is different from the effective Memory Clock, what is actually being displayed by GWE. It is also what other Windows applications like MSI Afterburner show. The Memory Transfer Rate is simply double the Memory Clock.

Where are the settings and profiles stored on the filesystem?

Installation type Location
Flatpak $HOME/.var/app/com.leinardi.gwe/
Source code $XDG_CONFIG_HOME (usually $HOME/.config/gwe)

GreenWithEnvy, why using such name?

The name comes from the slogan of the GeForce 8 series, that was "Green with envy".
Nvidia is meant to be pronounced "invidia", which means envy in Latin (and Italian). And their logo is green so, GreenWithEnvy

๐Ÿ’š How to help the project

We need people with experience in at least one of these topics:

  • Icon/Logo design (see #43)
  • Snap (see #18)
  • Getting current GTK theme text color (see #36)
  • Making Bumblebee work with Flatpak (see #35)

Knowing Python will be also very helpful but not strictly necessary.

Discord server

If you want to help testing or developing it would be easier to get in touch using the discord server of the project: https://discord.gg/YjPdNff
Just write a message on the general channel saying how you want to help (test, dev, etc) and quoting @leinardi. If you don't use discor but still want to help just open a new issue here.

Can I support this project some other way?

Something simple that everyone can do is to star it on both GitLab and GitHub. Feedback is always welcome: if you found a bug or would like to suggest a feature, feel free to open an issue on the issue tracker.

โš  Dropped PyPI support

Development builds were previously distributed using PyPI. This way of distributing the software is simple but requires the user to manually install all the non Python dependencies like cairo, glib, appindicator3, etc.
The current implementation of the historical data uses a new library, Dazzle, that requires Gnome 3.30 which is available, using Python Object introspection, only starting from Ubuntu 18.10 making the latest Ubuntu LTS, 18.04, unsupported.
A solution for all this problems is distributing the app via Flatpak, since with it all the dependencies will be bundled and provided automatically, making possible to use Gnome 3.30 features also on distributions using an older version of Gnome.

No new build will be published on PyPI.

Uninstall pip version

If you have already installed GWE via pip, please make sure to uninstall it completely before moving to a newer version:

pip3 uninstall gwe
rm -rf ~/.config/gwe

โ„น๏ธ Acknowledgements

Thanks to:

  • GabMus and TingPing for the huge help with Flatpak
  • The999eagle for maintaining the AUR package
  • Lighty for moderating the Discord server
  • fbcotter for the py3nvml library
  • all the devs of the python-xlib library
  • tiheum for the Faenza icons set, from which I took the current GWE launcher icon
  • all the people that helped testing and reported bugs

๐Ÿ“ฐ Media coverage

๐Ÿ“ License

This file is part of gwe.

Copyright (c) 2018 Roberto Leinardi

gwe is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

gwe is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with gwe.  If not, see <http://www.gnu.org/licenses/>.

Project Statistics

Sourcerank 4
Stars 130
Forks 10
Open issues 23
Dependencies 0
Tags 20
Created
Last updated

Packages Referencing this Repo

gwe
GUI to control cooling and overclock of nVidia cards
Latest release 0.5.1 - Updated - 130 stars

Recent Tags See all

0.13.0 September 01, 2019
0.12.3 February 24, 2019
0.12.2 February 24, 2019
0.12.1 February 24, 2019
0.12.0 February 17, 2019
0.11.0 February 10, 2019
0.10.3 February 09, 2019
0.10.2 February 09, 2019
0.10.1 February 03, 2019
0.10.0 February 03, 2019
0.6.0 February 03, 2019
0.9.0 February 02, 2019
0.8.0 January 30, 2019
0.7.0 January 26, 2019
0.5.1 January 03, 2019

Something wrong with this page? Make a suggestion

Last synced: 2019-10-08 06:12:31 UTC

Login to resync this repository