From e0e41d38d9447e44c0d20ce43a4f4c8df611782e Mon Sep 17 00:00:00 2001 From: Ian DesJardins Date: Tue, 30 Jul 2024 12:18:15 -0400 Subject: [PATCH] Update docs and delete example server config --- CONTRIBUTING.md | 2 -- README.md | 2 +- example_jupyter_jupyterlab_server_config.py | 9 --------- 3 files changed, 1 insertion(+), 12 deletions(-) delete mode 100644 example_jupyter_jupyterlab_server_config.py diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 86ea9f8..f6c2149 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -127,8 +127,6 @@ JupyterLab v3.0.0 jupyter-resource-usage v0.1.0 enabled OK ``` -There is an example config file included. - ## Which code creates what content The stats are created by the server-side code in `jupyter_resource_usage`. diff --git a/README.md b/README.md index 4023f6f..0ff3adb 100644 --- a/README.md +++ b/README.md @@ -145,7 +145,7 @@ c = get_config() c.ResourceUseDisplay.track_disk_usage = True ``` -The values are from the partition containing the folder in the trait `disk_path` (which defaults to `/home/joyvan`) +The values are from the partition containing the folder in the trait `disk_path` (which defaults to `/home/joyvan`). If this path does not exist, disk usage information is omitted from the display. Mirroring CPU and Memory, the trait `disk_warning_threshold` signifies when to flag a usage warning, and like the others, it defaults to `0.1` (10% remaining) diff --git a/example_jupyter_jupyterlab_server_config.py b/example_jupyter_jupyterlab_server_config.py deleted file mode 100644 index b14c788..0000000 --- a/example_jupyter_jupyterlab_server_config.py +++ /dev/null @@ -1,9 +0,0 @@ -c = get_config() # noqa -# resource monitor config -c.ResourceUseDisplay.track_cpu_percent = True -c.ResourceUseDisplay.cpu_limit = 4 - -c.ResourceUseDisplay.mem_limit = 8589934592 # 8GB - -c.ResourceUseDisplay.track_disk_usage = True -c.ResourceUseDisplay.disk_path = "/home"