https://github.com/thclark/cpplot

Interactive graphs and charts for C++, viewable in-browser
https://github.com/thclark/cpplot

cpp plotting

Last synced: 12 days ago
JSON representation

Interactive graphs and charts for C++, viewable in-browser

• Host: GitHub
• URL: https://github.com/thclark/cpplot
• Owner: thclark
• License: mit
• Created: 2018-07-29T09:30:15.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-08-11T15:49:09.000Z (about 4 years ago)
• Last Synced: 2024-10-14T16:33:54.309Z (25 days ago)
• Topics: cpp, plotting
• Language: C++
• Homepage: https://cpplot.readthedocs.io
• Size: 476 KB
• Stars: 88
• Watchers: 8
• Forks: 14
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)

[![black-girls-code](https://img.shields.io/badge/black%20girls-code-f64279.svg)](https://www.blackgirlscode.com/)

# cpplot

Interactive graphs and charts for C++ 11 upward,

[viewable in-browser using cpplot-viewer](https://cpplot.herokuapp.com).

Full documentation is at [https://cpplot.readthedocs.io](https://cpplot.readthedocs.io)

## For Developers

You should only need to read the following if you plan to develop on `cpplot`.

### Style guide

We use the [Google C++ style guide](https://google.github.io/styleguide/cppguide.html) with the following exceptions:

 - Don't care about line width so long as its within reason

 - Use 4 space indenting, not 2 as suggested by the style guide, because we're not [total monsters](https://www.youtube.com/watch?v=SsoOG6ZeyUI) (just kidding xx).

### Pre-Commit

You need to install pre-commit to get the hooks working. Do:

```

pip install pre-commit

pre-commit install

```

Once that's done, each time you make a commit, the following checks are made:

- valid github repo and files

- code style

- documentation builds correctly

Upon failure, the commit will halt. **Re-running the commit will automatically fix most issues** except:

- You'll have to fix documentation yourself prior to a successful commit (there's no auto fix for that!!).

You can run pre-commit hooks without making a commit, like:

```

pre-commit run build-docs

```

which is useful to locally build documents without crazy efforts setting up an environment for sphinx.

### Compilation with cmake

A cross-platform compilation file is provided using cmake, but it's **not tested on windows**.

PRs to fix or improve it for windows are most welcome.