recorder-viz
=============
This is a python package which contains tools for processing [Recorder](https://github.com/uiuc-hpc/Recorder) traces.
Installation and Visualization
-------------
`recorder-viz` relies on Recorder and a few python libraries to run.
Please see the document [here](https://recorder.readthedocs.io/latest/postprocessing.html#post-processing-and-visualization).
Below are some example graphs generated from the [FLASH](http://flash.uchicago.edu) traces.
Advanced Usages
-------------
The `RecorderReader` class contains all infomration about the Recorder traces.
```python
class RecorderReader:
self.GM: instance of GlobalMetadata
self.LMs: list of LocalMetadata objects, one for each rank
self.records: self.records[i] is a list of Record objects of rank i.
```
`GlobalMetadta`, `LocalMetadata` and `Record` are three Python wrappers of C structures.
```python
class LocalMetadata(Structure):
self.total_records: int
self.num_files: int
self.filemap: set()
self.function_count: []
class RecorderMetadata(Structure):
_fields_ = [
("total_ranks", c_int),
("start_ts", c_double),
("time_resolution", c_double),
("ts_buffer_elements", c_int),
("ts_compression_algo", c_int),
]
class Record(Structure):
_fields_ = [
("tstart", c_double),
("tend", c_double),
("level", c_ubyte),
("func_id", c_ubyte),
("tid", c_int),
("arg_count", c_ubyte),
("args", POINTER(c_char_p)),
]
```
Here's an example on how to use the provided classes.
```python
from recorder_viz import RecorderReader
reader = RecorderReader("path/to/Recorder-traces-folder")
for rank in range(reader.GM.total_ranks):
LM = reader.LMs[rank]
print("Rank: %d, Number of trace records: %d" %(rank, LM.total_records))
```
Raw data
{
"_id": null,
"home_page": "https://github.com/wangvsa/recorder-viz",
"name": "recorder-viz",
"maintainer": null,
"docs_url": null,
"requires_python": ">=2.7",
"maintainer_email": null,
"keywords": null,
"author": "Chen Wang",
"author_email": "wangvsa@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/1e/71/325225d2957b6c437bebaa22359e9d83dbbc438902b8d7db3b964ba5570b/recorder-viz-0.5.6.tar.gz",
"platform": null,
"description": "recorder-viz\n=============\n\nThis is a python package which contains tools for processing [Recorder](https://github.com/uiuc-hpc/Recorder) traces.\n\nInstallation and Visualization\n-------------\n\n`recorder-viz` relies on Recorder and a few python libraries to run.\nPlease see the document [here](https://recorder.readthedocs.io/latest/postprocessing.html#post-processing-and-visualization).\n\nBelow are some example graphs generated from the [FLASH](http://flash.uchicago.edu) traces.\n\n\n\nAdvanced Usages\n-------------\n\nThe `RecorderReader` class contains all infomration about the Recorder traces.\n\n```python\nclass RecorderReader:\n self.GM: instance of GlobalMetadata\n self.LMs: list of LocalMetadata objects, one for each rank\n self.records: self.records[i] is a list of Record objects of rank i.\n```\n\n`GlobalMetadta`, `LocalMetadata` and `Record` are three Python wrappers of C structures. \n\n```python\nclass LocalMetadata(Structure):\n self.total_records: int\n self.num_files: int\n self.filemap: set()\n self.function_count: []\n\n\nclass RecorderMetadata(Structure):\n _fields_ = [\n (\"total_ranks\", c_int),\n (\"start_ts\", c_double),\n (\"time_resolution\", c_double),\n (\"ts_buffer_elements\", c_int),\n (\"ts_compression_algo\", c_int),\n ]\n\nclass Record(Structure):\n _fields_ = [\n (\"tstart\", c_double),\n (\"tend\", c_double),\n (\"level\", c_ubyte),\n (\"func_id\", c_ubyte),\n (\"tid\", c_int),\n (\"arg_count\", c_ubyte),\n (\"args\", POINTER(c_char_p)),\n ]\n```\n\n\nHere's an example on how to use the provided classes.\n\n```python\nfrom recorder_viz import RecorderReader\n\nreader = RecorderReader(\"path/to/Recorder-traces-folder\")\n\nfor rank in range(reader.GM.total_ranks):\n LM = reader.LMs[rank]\n print(\"Rank: %d, Number of trace records: %d\" %(rank, LM.total_records))\n```\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Utilities for processing Recorder traces",
"version": "0.5.6",
"project_urls": {
"Homepage": "https://github.com/wangvsa/recorder-viz"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1e71325225d2957b6c437bebaa22359e9d83dbbc438902b8d7db3b964ba5570b",
"md5": "658d1e7096f8ad6f64bc77349a1eb143",
"sha256": "7abc7eb7cc3d4410eb90221469a5fcc085e603298fd9b484cfcbfa70c18ecac9"
},
"downloads": -1,
"filename": "recorder-viz-0.5.6.tar.gz",
"has_sig": false,
"md5_digest": "658d1e7096f8ad6f64bc77349a1eb143",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=2.7",
"size": 1055234,
"upload_time": "2024-08-14T18:17:37",
"upload_time_iso_8601": "2024-08-14T18:17:37.057554Z",
"url": "https://files.pythonhosted.org/packages/1e/71/325225d2957b6c437bebaa22359e9d83dbbc438902b8d7db3b964ba5570b/recorder-viz-0.5.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-14 18:17:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wangvsa",
"github_project": "recorder-viz",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "recorder-viz"
}
JSON
