Metadata-Version: 2.1
Name: sonar
Version: 0.4.2
Summary: Tool to profile usage of HPC resources by regularly probing processes using ps.
Home-page: https://github.com/nordichpc/sonar
Maintainer: Radovan Bast
License: UNKNOWN
Description: [![Builds](https://travis-ci.org/nordichpc/sonar.svg?branch=master)](https://travis-ci.org/nordichpc/sonar/builds)
        [![License](https://img.shields.io/badge/license-%20GPL--v3.0-blue.svg)](LICENSE)
        [![PyPI version](https://badge.fury.io/py/sonar.svg)](https://badge.fury.io/py/sonar)
        
        
        # sonar
        
        Tool to profile usage of HPC resources by regularly probing processes
        using `ps`.
        
        - Reference implementation which serves as inspiration: <https://github.com/UNINETTSigma2/appusage>
        - [Design goals and design decisions](doc/design.md)
        - Status: alpha, API might change, but we already use it on one cluster
        - [Contributing](doc/contributing.md)
        
        
        ## Similar tools
        
        - [TACC Stats](https://github.com/TACC/tacc_stats)
        
        
        ## Related tools which integrate with Sonar
        
        - [sonar-web](https://github.com/NordicHPC/sonar-web): Plots daily/weekly/monthly CPU usage summary for clusters.
        
        
        ## Authors
        
        - Henrik Rojas Nagel
        - Mathias Bockwoldt
        - [Radovan Bast](https://bast.fr)
        
        
        ## Installation
        
        ### Installing from PyPI
        
        Ideally install into a virtual environment or Pipenv:
        
        ```
        $ pip install sonar
        ```
        
        
        ### Installing from sources
        
        ```
        $ git clone https://github.com/nordichpc/sonar.git
        $ cd sonar
        $ virtualenv venv
        $ source venv/bin/activate
        $ pip install -e .
        ```
        
        
        ## Using sonar
        
        - [Overview](doc/usage/overview.md)
        - [Taking snapshots with sonar snap](doc/usage/snap.md)
        - [Map processes to applications with sonar map](doc/usage/map.md)
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
