<p align="center">
<img src="https://github.com/hpc-io/io-insights/blob/master/images/drishti-logo.png?raw=true" alt="Drishti"/>
</p>
# Drishti: I/O Insights for All
Drishti is a command-line tool to guide end-users in optimizing I/O in their applications by detecting typical I/O performance pitfalls and providing a set of recommendations. You can get Drishti directly from pip:
```
pip install drishti-io
```
To install Drishti from scratch, make sure you have Python 3 and first install the dependencies:
```
pip install -r requirements.txt
pip install .
```
You can then run Drishti with the following options:
```
usage: drishti.py [-h] [--issues] [--html] [--svg] [--verbose] [--code] darshan
Drishti:
positional arguments:
darshan Input .darshan file
optional arguments:
-h, --help show this help message and exit
--issues Only displays the detected issues and hides the recommendations
--html Export the report as an HTML page
--svg Export the report as an SVG image
--verbose Display extended details for the recommendations
--code Display insights identification code
```
You can also use our Docker image:
```
docker run --rm --mount type=bind,source="$(PWD)",target=/drishti drishti sample/jlbez_8a_benchmark_write_parallel_id1321662_8-21-5892-15802854900629188750_106.darshan
```
You can also use a Docker image already pre-configured with all dependencies to run Drishti:
```
docker pull hpcio/drishti
```
Since we need to provide a Darshan log file as input, make sure you are mounting your current directory in the container and removing the container after using it. You can pass the same arguments described above, after the container name (drishti).
```
docker run --rm --mount \
type=bind,source="$(PWD)",target="/drishti" \
drishti <FILE>.darshan
```
By default Drishti will generate an overview report in the console with recommendations:
<p align="center">
<img src="https://github.com/hpc-io/io-insights/blob/master/images/sample-io-insights.svg?raw=true" alt="Drishti"/>
</p>
You can also only list the issues detected by Drishti with `--issues`:
<p align="center">
<img src="https://github.com/hpc-io/io-insights/blob/master/images/sample-io-insights-issues.svg?raw=true" alt="Drishti"/>
</p>
You can also enable the verbose mode with `--verbose` to visualize solution snippets:
<p align="center">
<img src="https://github.com/hpc-io/io-insights/blob/master/images/sample-io-insights-verbose.svg?raw=true" alt="Drishti"/>
</p>
---
### Copyright Notice
Drishti Copyright (c) 2022, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy). All rights reserved.
If you have questions about your rights to use or distribute this software, please contact Berkeley Lab's Intellectual Property Office at IPO@lbl.gov.
NOTICE. This Software was developed under funding from the U.S. Department of Energy and the U.S. Government consequently retains certain rights. As such, the U.S. Government has been granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable, worldwide license in the Software to reproduce, distribute copies to the public, prepare derivative works, and perform publicly and display publicly, and to permit others to do so.
Raw data
{
"_id": null,
"home_page": "https://github.com/hpc-io/drishti",
"name": "drishti-io",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "drishti",
"author": "Jean Luca Bez, Suren Byna",
"author_email": "jlbez@lbl.gov, sbyna@lbl.gov",
"download_url": "https://files.pythonhosted.org/packages/c9/b3/0dcf3d501d1eeec1e37d6f54a492ac123fb5d7879a7095f0e6a076128a0c/drishti-io-0.5.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img src=\"https://github.com/hpc-io/io-insights/blob/master/images/drishti-logo.png?raw=true\" alt=\"Drishti\"/>\n</p>\n\n# Drishti: I/O Insights for All\n\nDrishti is a command-line tool to guide end-users in optimizing I/O in their applications by detecting typical I/O performance pitfalls and providing a set of recommendations. You can get Drishti directly from pip:\n\n```\npip install drishti-io\n```\n\nTo install Drishti from scratch, make sure you have Python 3 and first install the dependencies:\n\n```\npip install -r requirements.txt\npip install .\n```\n\nYou can then run Drishti with the following options:\n\n```\nusage: drishti.py [-h] [--issues] [--html] [--svg] [--verbose] [--code] darshan\n\nDrishti:\n\npositional arguments:\n darshan Input .darshan file\n\noptional arguments:\n -h, --help show this help message and exit\n --issues Only displays the detected issues and hides the recommendations\n --html Export the report as an HTML page\n --svg Export the report as an SVG image\n --verbose Display extended details for the recommendations\n --code Display insights identification code\n```\n\nYou can also use our Docker image:\n\n```\ndocker run --rm --mount type=bind,source=\"$(PWD)\",target=/drishti drishti sample/jlbez_8a_benchmark_write_parallel_id1321662_8-21-5892-15802854900629188750_106.darshan\n```\n\n\nYou can also use a Docker image already pre-configured with all dependencies to run Drishti:\n\n```\ndocker pull hpcio/drishti\n```\n\nSince we need to provide a Darshan log file as input, make sure you are mounting your current directory in the container and removing the container after using it. You can pass the same arguments described above, after the container name (drishti).\n\n```\ndocker run --rm --mount \\\n type=bind,source=\"$(PWD)\",target=\"/drishti\" \\\n drishti <FILE>.darshan\n```\n\nBy default Drishti will generate an overview report in the console with recommendations:\n\n<p align=\"center\">\n <img src=\"https://github.com/hpc-io/io-insights/blob/master/images/sample-io-insights.svg?raw=true\" alt=\"Drishti\"/>\n</p>\n\nYou can also only list the issues detected by Drishti with `--issues`:\n\n<p align=\"center\">\n <img src=\"https://github.com/hpc-io/io-insights/blob/master/images/sample-io-insights-issues.svg?raw=true\" alt=\"Drishti\"/>\n</p>\n\nYou can also enable the verbose mode with `--verbose` to visualize solution snippets:\n\n<p align=\"center\">\n <img src=\"https://github.com/hpc-io/io-insights/blob/master/images/sample-io-insights-verbose.svg?raw=true\" alt=\"Drishti\"/>\n</p>\n\n---\n\n### Copyright Notice\n\nDrishti Copyright (c) 2022, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy). All rights reserved.\n\nIf you have questions about your rights to use or distribute this software, please contact Berkeley Lab's Intellectual Property Office at IPO@lbl.gov.\n\nNOTICE. This Software was developed under funding from the U.S. Department of Energy and the U.S. Government consequently retains certain rights. As such, the U.S. Government has been granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable, worldwide license in the Software to reproduce, distribute copies to the public, prepare derivative works, and perform publicly and display publicly, and to permit others to do so.\n\n",
"bugtrack_url": null,
"license": "",
"summary": "",
"version": "0.5",
"split_keywords": [
"drishti"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bd3d7521abed634fb632f13a41366435337ae4ec78712b8332ed2477ce2f1db3",
"md5": "e779ef1c5a788372109ab139d325fdd5",
"sha256": "eb676659e7ea32174ab57be2d0a263e2b6dc18b39b26d31eea10d9142239608b"
},
"downloads": -1,
"filename": "drishti_io-0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e779ef1c5a788372109ab139d325fdd5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 20854,
"upload_time": "2023-02-08T23:40:36",
"upload_time_iso_8601": "2023-02-08T23:40:36.250942Z",
"url": "https://files.pythonhosted.org/packages/bd/3d/7521abed634fb632f13a41366435337ae4ec78712b8332ed2477ce2f1db3/drishti_io-0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c9b30dcf3d501d1eeec1e37d6f54a492ac123fb5d7879a7095f0e6a076128a0c",
"md5": "cbf5b1ee38c581ef043dcf2969e1a756",
"sha256": "08ae82dfa82872cde1f0a219e979b9c10d6c4a01f762066ea864a400cc144d78"
},
"downloads": -1,
"filename": "drishti-io-0.5.tar.gz",
"has_sig": false,
"md5_digest": "cbf5b1ee38c581ef043dcf2969e1a756",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 19105,
"upload_time": "2023-02-08T23:40:38",
"upload_time_iso_8601": "2023-02-08T23:40:38.135096Z",
"url": "https://files.pythonhosted.org/packages/c9/b3/0dcf3d501d1eeec1e37d6f54a492ac123fb5d7879a7095f0e6a076128a0c/drishti-io-0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-08 23:40:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "hpc-io",
"github_project": "drishti",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "drishti-io"
}
JSON
