Metadata-Version: 2.4
Name: icsystemutils
Version: 0.0.17
Summary: Utilities for interacting with system resources, e.g. cpu, network etc.
Author-email: "James Grogan, Irish Centre for High End Computing" <james.grogan@ichec.ie>
Project-URL: Repository, https://git.ichec.ie/performance/toolshed/icsystemutils
Project-URL: Homepage, https://git.ichec.ie/performance/toolshed/icsystemutils
Keywords: System Utilities,HPC
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Topic :: System :: Distributed Computing
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: iccore==0.1.13
Requires-Dist: psutil
Requires-Dist: fabric>=3.2.2
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: pytest-sugar; extra == "test"
Requires-Dist: black; extra == "test"
Requires-Dist: mypy; extra == "test"
Requires-Dist: flake8; extra == "test"
Requires-Dist: pylint; extra == "test"
Dynamic: license-file

`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 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.
