| Name | icsystemutils JSON |
| Version |
0.2.4
JSON |
| download |
| home_page | None |
| Summary | Utilities for interacting with system resources, e.g. cpu, network etc. |
| upload_time | 2025-08-28 14:46:41 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
system utilities
hpc
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
`icsystemutils` is a library for querying system resources (cpu, gpu, network etc).
It is used in higher-level packages and tools in [Irish Centre for High End Computing (ICHEC)](https://www.ichec.ie) research and workflows.
# Features #
You can read system CPU info on Linux or Mac via system APIs with JSON output:
``` shell
icsystemutils read_cpu
```
You can read a system's NVIDIA GPU info and output:
``` shell
icsystemutils read_gpu
```
You can run a resource monitor that outputs CPU and memory use to a file with:
``` shell
icsystemutils monitor
```
You can also run this monitor on GPUs and record their use to a CSV with:
```shell
icsystemutils monitor --include gpu --output_path <path_to_csv_dir>
```
You can run a resource monitor that outputs NVIDIA GPU use to a file with:
You can postprocess a log file with:
``` shell
icsystemutils tracing --trace_file <file_with_traces> --trace_config <trace_config_file>
```
The log file should have traces in the format `timestamp | thread_id | message` where the timestamp is Unix time as a float with whole numbers representing seconds. The `message` is used to determine start and end points for events. `The trace_config_file` is a json file used to match strings in the message with Event start and end flags. The output is a series of trace events in json format, which can be used to generate plots with `icplot` or used in further analysis.
# Installation #
You can install it with:
``` shell
pip install icsystemutils
```
# License #
This project is Copyright of the Irish Centre for High End Computing. You can use it under the terms of the GPLv3+, which further details in the included LICENSE file.
Raw data
{
"_id": null,
"home_page": null,
"name": "icsystemutils",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "System Utilities, HPC",
"author": null,
"author_email": "Irish Centre for High End Computing <james.grogan@ichec.ie>",
"download_url": "https://files.pythonhosted.org/packages/cb/57/6fd7a2d73d36b06df94e8e4db85e0f6cd26338c0742e255e4daf459e3d78/icsystemutils-0.2.4.tar.gz",
"platform": null,
"description": "`icsystemutils` is a library for querying system resources (cpu, gpu, network etc).\n\nIt is used in higher-level packages and tools in [Irish Centre for High End Computing (ICHEC)](https://www.ichec.ie) research and workflows.\n\n# Features #\n\nYou can read system CPU info on Linux or Mac via system APIs with JSON output:\n\n``` shell\nicsystemutils read_cpu\n```\n\nYou can read a system's NVIDIA GPU info and output:\n\n``` shell\nicsystemutils read_gpu\n```\n\nYou can run a resource monitor that outputs CPU and memory use to a file with:\n\n\n``` shell\nicsystemutils monitor\n```\n\nYou can also run this monitor on GPUs and record their use to a CSV with:\n\n\n```shell\nicsystemutils monitor --include gpu --output_path <path_to_csv_dir>\n```\n\nYou can run a resource monitor that outputs NVIDIA GPU use to a file with:\n\n\nYou can postprocess a log file with:\n\n``` shell\nicsystemutils tracing --trace_file <file_with_traces> --trace_config <trace_config_file>\n```\n\nThe log file should have traces in the format `timestamp | thread_id | message` where the timestamp is Unix time as a float with whole numbers representing seconds. The `message` is used to determine start and end points for events. `The trace_config_file` is a json file used to match strings in the message with Event start and end flags. The output is a series of trace events in json format, which can be used to generate plots with `icplot` or used in further analysis. \n\n\n# Installation #\n\nYou can install it with:\n\n``` shell\npip install icsystemutils\n```\n\n# License #\n\nThis project is Copyright of the Irish Centre for High End Computing. You can use it under the terms of the GPLv3+, which further details in the included LICENSE file.\n",
"bugtrack_url": null,
"license": null,
"summary": "Utilities for interacting with system resources, e.g. cpu, network etc.",
"version": "0.2.4",
"project_urls": {
"Homepage": "https://git.ichec.ie/performance/toolshed/icsystemutils",
"Repository": "https://git.ichec.ie/performance/toolshed/icsystemutils"
},
"split_keywords": [
"system utilities",
" hpc"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d50ad9027dbd8cea5426fd52b8b55f99fd208391a7d0b5d3ddfb1132308039a7",
"md5": "c69af8207a54cb9e02582aa9170be774",
"sha256": "922e8980b2198fc0fcbb53ab072933875e71b19bb5547c04fc07aac464cac1d0"
},
"downloads": -1,
"filename": "icsystemutils-0.2.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c69af8207a54cb9e02582aa9170be774",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 27429,
"upload_time": "2025-08-28T14:46:40",
"upload_time_iso_8601": "2025-08-28T14:46:40.434902Z",
"url": "https://files.pythonhosted.org/packages/d5/0a/d9027dbd8cea5426fd52b8b55f99fd208391a7d0b5d3ddfb1132308039a7/icsystemutils-0.2.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "cb576fd7a2d73d36b06df94e8e4db85e0f6cd26338c0742e255e4daf459e3d78",
"md5": "ad3a2c1b0485495782350388902f11ab",
"sha256": "688e5738b144821ab53f35d84c0a0ce0167515078209bf316dada8e21222030e"
},
"downloads": -1,
"filename": "icsystemutils-0.2.4.tar.gz",
"has_sig": false,
"md5_digest": "ad3a2c1b0485495782350388902f11ab",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 24703,
"upload_time": "2025-08-28T14:46:41",
"upload_time_iso_8601": "2025-08-28T14:46:41.826718Z",
"url": "https://files.pythonhosted.org/packages/cb/57/6fd7a2d73d36b06df94e8e4db85e0f6cd26338c0742e255e4daf459e3d78/icsystemutils-0.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-28 14:46:41",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "icsystemutils"
}
