scope-plot 0.2.4
Plot Google Benchmark results
License: Apache 2.0
Keywords: scope_plot

# ScopePlot

[![Build Status](https://travis-ci.com/c3sr/scope_plot.svg?branch=master)](https://travis-ci.com/c3sr/scope_plot)


Plot Google Benchmark results

## Getting Started with ScopePlot

ScopePlot is available on [PyPI](https://pypi.org/project/scope-plot/) can be installed with `pip`

    $ python -m pip install scope_plot

To install the latest development version from [Github](https://github.com/rai-project/scope_plot)

    $ python -m pip install git+git://github.com/c3sr/scope_plot.git

If your current Python installation doesn't have pip available, try [get-pip.py](bootstrap.pypa.io)

After installing ScopePlot you can use it like any other Python module.
Here's a very simple example:

```bash
$ python -m scope_plot bar data.json
```

There are multiple subcommands available

```
$ python -m scope_plot --help

Usage: __main__.py [OPTIONS] COMMAND [ARGS]...

Options:
  --debug / --no-debug  print debug messages to stderr.
  --include DIRECTORY   Search location for input_file in spec.
  --help                Show this message and exit.

Commands:
  bar   Create a bar graph from BENCHMARK and write...
  deps  Create a Makefile dependence
  spec  Create a figure from a spec file
```

More information about the subcommands can be accessed with `python -m scope_plot COMMAND --help`, and also in the documentation: [bar](docs/bar.md), [spec](docs/spec.md), [deps](docs/makefiles.md).

API Reference
-------------

coming soon...

Support / Report Issues
-----------------------

All support requests and issue reports should be
[filed on Github as an issue](https://github.com/rai-project/scope_plot/issues).
Make sure to follow the template so your request may be as handled as quickly as possible.
Please respect contributors by not using personal contacts for support requests.

Contributing
------------

We happily welcome contributions, please see [our guide for Contributors](CONTRIBUTORS.md) for the best places to start and help.

License
-------

scope_plot is made available under the Apache 2.0 License. For more details, see [LICENSE.txt](https://github.com/c3sr/scope_plot/blob/master/LICENSE.txt).


Changelog
=========

Release 0.2.3 (Development)
---------------------------
* Use `agg` matplotlib backend if tkinter cannot be imported
* allow subplots to have error bars
* hide error bar labels by default
* add linestyle spec to matplotlib errorbars
* don't resolve path for scope_plot deps since makefiles probably expect target names to be relative
* print error when an input file is not found

Release 0.2.2 (Development)
---------------------------
* Add NOTICE and Apache 2.0 LICENSE
* Fixed a bug where ScopePlot would not run without DISPLAY environment set
* Use TkAgg backend on macOS to support running from a virtualenv
* Allow non-numeric x data in bar plots
* Add support for the `output` field in spec files


Release 0.2.1 (Development)
---------------------------
* Fix bugs in handling labels, color, regex for matplotlib and regex backends

Release 0.2.0 (Development)
---------------------------

* Refactor some underlying data structures
* break matplotlib backend

Release 0.1.5 (Development)
---------------------------

* Enable strict checking of spec files by default
* Sort benchmark data
* Omit invalid benchmark data

Release 0.1.3 (Development)
---------------------------

* Change documentation to docsify
* Fix a bug with unexpected "strict" argument

Release 0.1.2 (Development)
---------------------------

* rename to `scope_plot`
* Initial support for `spec` and `bar` subcommands.