viewclust 0.8.0
Python package for visualizing cluster measures.
License: MIT license
Requires Python: >=3.5
Keywords: viewclust

=========
ViewClust
=========


.. image:: https://img.shields.io/pypi/v/viewclust.svg
        :target: https://pypi.python.org/pypi/viewclust

.. image:: https://img.shields.io/travis/Andesha/viewclust.svg
        :target: https://travis-ci.com/Andesha/viewclust

.. image:: https://readthedocs.org/projects/viewclust/badge/?version=latest
        :target: https://viewclust.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status




Python package for computing cluster measures.


* Free software: MIT license
* Documentation: https://viewclust.readthedocs.io.


Features
--------

* Calculates job usage based on inputs from Slurm or other formatted data frames
* Plots cumulative and instantaneous usage
* Accepts dynamic targets for account and system analysis
* Provides a basic interface for generating job data frames from Slurm

For more plotting options and dashboard suites see the ViewClust-Vis_ package.


Credits
-------

* `Tyler Collins`_
* `James Desjardins`_
* `Sergiy Khan`_
* `Pier-Luc St-Onge`_
* `Jose Sergio Hleap`_
* `Chris Want`_

Developed for:

* SHARCNET_
* `Compute Canada`_

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
.. _`Tyler Collins`: https://github.com/Andesha
.. _`James Desjardins`: https://github.com/jadesjardins
.. _`Sergiy Khan`: https://github.com/sergiykhan
.. _`Pier-Luc St-Onge`: https://github.com/plstonge
.. _`Jose Sergio Hleap`: https://github.com/jshleap
.. _SHARCNET: https://www.sharcnet.ca/my/front/
.. _`Compute Canada`: https://www.computecanada.ca/
.. _ViewClust-Vis: https://github.com/Andesha/ViewClust-Vis
.. _`Chris Want`: https://github.com/cwant


=======
History
=======

0.8.0 (2023-02-02)
------------------

* Add eligible queued metric
* Bump internal package versions


0.7.3 (2021-09-07)
------------------

* Fix end time sacct bug
* Specify protocol for pickle output format


0.7.2 (2021-09-03)
------------------

* Add alloctres to sacct fields


0.7.1 (2021-09-03)
------------------

* Reimplement serialization of sacct frames


0.7.0 (2021-09-02)
------------------

* Refactor/add new sacct polling script to be much more robust


0.6.1 (2021-07-20)
------------------

* Optimize job use calculations


0.6.0 (2021-01-14)
------------------

* Add support for horizon measures when studying job usage


0.5.0 (2020-10-28)
------------------

* Code linting fixes
* Revert modern plotting features and added to ViewClust-Vis
* Job use now calculates more theoretical lines
* Added return handles for figures that were missing them
* Added parameter for groupby frequency inside of job use


0.4.5 (2020-09-15)
------------------

* Bug fix on sacct poller


0.4.4 (2020-09-14)
------------------

* Added ability to sacct poll all accounts in slurm submodule


0.4.3 (2020-07-22)
------------------

* Refactor calculations for eqv use_unit measures
* Completed support for gpu eqv usage calculations


0.4.2 (2020-07-15)
------------------

* Minor formatting to mem info parsing


0.4.1 (2020-07-13)
------------------

* Can now serialize user run
* Crediting Sergio!


0.4.0 (2020-07-07)
------------------

* Add new support for plotting to the terminal
* Bug fix stderr output


0.3.2 (2020-06-25)
------------------

* Docs update for new changes


0.3.1 (2020-06-24)
------------------

* Bug fix for the init py file


0.3.0 (2020-06-24)
------------------

* Major versioning bump
* User area colouring in usage figures
* Mem info plotting support
* Serialization of user
* Removed violin plot. Moved to ViewClust-Vis
* Removed use_suite. Moved to ViewClust-Vis
* Removed job_stack. Moved to ViewClust-Vis
* Deprecated cumu/insta plotting function. Supported versions moved to ViewClust-Vis


0.2.2 (2020-05-07)
------------------

* Added support for user breakdown of activity on plots


0.2.1 (2020-04-14)
------------------

* Fixed other half of instaplot bug


0.2.0 (2020-04-14)
------------------

* Fix use suite string passing bug


0.1.9 (2020-04-14)
------------------

* Fix insta plot pre reference bug


0.1.8 (2020-04-09)
------------------

* Fix syntax based errors


0.1.7 (2020-04-09)
------------------

* Fix failing doc build


0.1.6 (2020-04-09)
------------------

* GPU usage added back
* README fixes to include credits and features
* Figures now return their handles for extra processing if needed
* Figures can now have their polling rates downsampled for ease of sharing
* Prepared responses for figures section added in to documentation


0.1.5 (2020-03-12)
------------------

* Inclusion of API documentation


0.1.4 (2020-03-11)
------------------

* Overhauled the documentation usage section


0.1.3 (2020-03-03)
------------------

* Reduced versioning complexity


0.1.2 (2020-03-03)
------------------

* Testing distributions changed


0.1.1 (2020-03-03)
------------------

* File inclusion


0.1.0 (2020-03-03)
------------------

* First release on PyPI.