icsystemutils


Nameicsystemutils JSON
Version 0.2.3 PyPI version JSON
download
home_pageNone
SummaryUtilities for interacting with system resources, e.g. cpu, network etc.
upload_time2025-07-30 12:38:19
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseNone
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 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/f4/8f/ce255391ef4d8418a50c97b7df5c39e8f9042af21ffd42f2a2b759e51ec0/icsystemutils-0.2.3.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 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.3",
    "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": "806292a133de8ce282328ddf66f637460b7f5dbed853f6411daae7cb3503ce7c",
                "md5": "cc0cdc132d81b77c514b3bd4d7679b1a",
                "sha256": "2321cd6c84aeec968179e7e18f50ec91f84b25e0771d22608bb6fe5ae40c2a2c"
            },
            "downloads": -1,
            "filename": "icsystemutils-0.2.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "cc0cdc132d81b77c514b3bd4d7679b1a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 24725,
            "upload_time": "2025-07-30T12:38:16",
            "upload_time_iso_8601": "2025-07-30T12:38:16.078844Z",
            "url": "https://files.pythonhosted.org/packages/80/62/92a133de8ce282328ddf66f637460b7f5dbed853f6411daae7cb3503ce7c/icsystemutils-0.2.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "f48fce255391ef4d8418a50c97b7df5c39e8f9042af21ffd42f2a2b759e51ec0",
                "md5": "7e41cc3c3b4012872bfe2d3be5a69b88",
                "sha256": "2d2d670334aea13fba70bef9e9f67d316ef1bb3e3ff065655c0a7fc8a1d34a29"
            },
            "downloads": -1,
            "filename": "icsystemutils-0.2.3.tar.gz",
            "has_sig": false,
            "md5_digest": "7e41cc3c3b4012872bfe2d3be5a69b88",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 22803,
            "upload_time": "2025-07-30T12:38:19",
            "upload_time_iso_8601": "2025-07-30T12:38:19.832090Z",
            "url": "https://files.pythonhosted.org/packages/f4/8f/ce255391ef4d8418a50c97b7df5c39e8f9042af21ffd42f2a2b759e51ec0/icsystemutils-0.2.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-30 12:38:19",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "icsystemutils"
}
        
Elapsed time: 1.72434s