icsystemutils


Nameicsystemutils JSON
Version 0.0.11 PyPI version JSON
download
home_pageNone
SummaryUtilities for interacting with system resources, e.g. cpu, network etc.
upload_time2024-10-08 09:34:47
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
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 Python package with some low-level utilities for interacting with real system resources (cpu, gpu, network etc).

It is maintained by the Irish Centre for High End Computing (ICHEC), mostly as a dependency of high-level packages and tools used to support ICHEC research and workflows.

# Examples #

Although this is mostly intended to be a library, some example uses to build CLI apps are shown below.

You can read the system CPU info on Linux/Mac via system apis and returns the result as json with:

``` shell
icsystemutils read_cpu
```

You can run a basic resource monitor that outputs CPU and memory use to a file with:


``` shell
icsystemutils monitor
```

You can postprocess a log file with trace info in a specified format with:

``` shell
icsystemutils tracing --trace_file <log_file_with_traces> --trace_config <trace_config_file>
```

The log file should have traces of 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. 

# 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.8",
    "maintainer_email": null,
    "keywords": "System Utilities, HPC",
    "author": null,
    "author_email": "\"James Grogan, Irish Centre for High End Computing\" <james.grogan@ichec.ie>",
    "download_url": "https://files.pythonhosted.org/packages/53/4a/c986e36f4475ac6a4e74d8cc033de765788c25c2e0cc0dc53927f1b607ff/icsystemutils-0.0.11.tar.gz",
    "platform": null,
    "description": "`icsystemutils` is a Python package with some low-level utilities for interacting with real system resources (cpu, gpu, network etc).\n\nIt is maintained by the Irish Centre for High End Computing (ICHEC), mostly as a dependency of high-level packages and tools used to support ICHEC research and workflows.\n\n# Examples #\n\nAlthough this is mostly intended to be a library, some example uses to build CLI apps are shown below.\n\nYou can read the system CPU info on Linux/Mac via system apis and returns the result as json with:\n\n``` shell\nicsystemutils read_cpu\n```\n\nYou can run a basic 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 trace info in a specified format with:\n\n``` shell\nicsystemutils tracing --trace_file <log_file_with_traces> --trace_config <trace_config_file>\n```\n\nThe log file should have traces of 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# 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.0.11",
    "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": "",
            "digests": {
                "blake2b_256": "af6012ea8872be9204de3cc826ae7a75010423056d6f39c0c4d973aacfa7dcb9",
                "md5": "64a22751667dfa879ab713204755be75",
                "sha256": "859d50a5cc18d774a224369fdf5bbab7c81ddb18388d84150f4bd3f2d3eb15e7"
            },
            "downloads": -1,
            "filename": "icsystemutils-0.0.11-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "64a22751667dfa879ab713204755be75",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 23716,
            "upload_time": "2024-10-08T09:34:46",
            "upload_time_iso_8601": "2024-10-08T09:34:46.855148Z",
            "url": "https://files.pythonhosted.org/packages/af/60/12ea8872be9204de3cc826ae7a75010423056d6f39c0c4d973aacfa7dcb9/icsystemutils-0.0.11-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "534ac986e36f4475ac6a4e74d8cc033de765788c25c2e0cc0dc53927f1b607ff",
                "md5": "5cbfe31c8c021e54a5d503be62b2dbdd",
                "sha256": "a74477d6ae256751df77d16b97a2a7df1e42afc2038cd47878bd49041b32302b"
            },
            "downloads": -1,
            "filename": "icsystemutils-0.0.11.tar.gz",
            "has_sig": false,
            "md5_digest": "5cbfe31c8c021e54a5d503be62b2dbdd",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 21256,
            "upload_time": "2024-10-08T09:34:47",
            "upload_time_iso_8601": "2024-10-08T09:34:47.962656Z",
            "url": "https://files.pythonhosted.org/packages/53/4a/c986e36f4475ac6a4e74d8cc033de765788c25c2e0cc0dc53927f1b607ff/icsystemutils-0.0.11.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-08 09:34:47",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "icsystemutils"
}
        
Elapsed time: 0.92198s