https://github.com/stephane-caron/foxplot

Plot time series from MessagePack or line-delimited JSON
https://github.com/stephane-caron/foxplot

Last synced: 2 months ago
JSON representation

Plot time series from MessagePack or line-delimited JSON

• Host: GitHub
• URL: https://github.com/stephane-caron/foxplot
• Owner: stephane-caron
• License: apache-2.0
• Created: 2022-12-19T12:51:49.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-26T12:31:04.000Z (9 months ago)
• Last Synced: 2024-10-13T16:31:11.088Z (8 months ago)
• Language: JavaScript
• Homepage:
• Size: 437 KB
• Stars: 5
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# foxplot

[![Build](https://img.shields.io/github/actions/workflow/status/stephane-caron/foxplot/ci.yml?branch=main)](https://github.com/stephane-caron/foxplot/actions)

[![Documentation](https://img.shields.io/github/actions/workflow/status/stephane-caron/foxplot/docs.yml?branch=main&label=docs)](https://stephane-caron.github.io/foxplot/)

[![Coverage](https://coveralls.io/repos/github/stephane-caron/foxplot/badge.svg?branch=main)](https://coveralls.io/github/stephane-caron/foxplot?branch=main)

[![PyPI version](https://img.shields.io/pypi/v/foxplot)](https://pypi.org/project/foxplot/)

Manipulate time series read from [MessagePack](https://msgpack.org/) or [newline-delimited JSON](https://en.wikipedia.org/wiki/JSON_streaming#Newline-delimited-JSON).

## Installation

```console

pip install foxplot

```

## Usage

The `foxplot` command-line tool starts in interactive mode by default to explore the input gathered in `data` (tab completion works: try `data.`). Plot times series using the `fox.plot` function, for example:

```python

$ foxplot upkie_2023-05-03-103245.mpack

Python 3.8.10 (default, Mar 13 2023, 10:26:41)

Type 'copyright', 'credits' or 'license' for more information

IPython 8.0.1 -- An enhanced Interactive Python. Type '?' for help.

In [1]: fox.plot(data.observation.imu.angular_velocity)

```

This call opens a new tab in your browser with the desired plot. In this example, `angular_velocity` is a 3D vector, thus the plot will include three curves.

Check out the [documentation](https://stephane-caron.github.io/foxplot/) for more advanced examples, such as left and right axes or computing new series from existing ones.

## See also

- [mpacklog.cpp](https://github.com/stephane-caron/mpacklog.cpp): library to log dictionaries to MessagePack files in C++.

- [mpacklog.py](https://github.com/stephane-caron/mpacklog.py): library and command-line tools to log dictionaries to MessagePack files in Python.

- [rq](https://github.com/dflemstr/rq/): command-line tool to manipulate streams of records in various formats.

- [uplot-python](https://github.com/stephane-caron/uplot-python): plotting backend used in this project.

- [µPlot](https://github.com/leeoniya/uPlot): time-series plotting library, whose performance was a key enabler for this project.