Skip to main content

Vernacular Figure Description

Project description

=============================
Vernacular Figure Description
=============================


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

.. image:: https://img.shields.io/travis/Dih5/vfd.svg
:target: https://travis-ci.org/Dih5/vfd

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




VFD (Vernacular Figure Description) is a JSON-based description system for plots. It aims to describe *what* needs to be
plotted, while *how* it is done is decided when the files are opened. This allows to generate a set of files describing
the plots, which can latter be batch-processed to produce a consistent set of figures.

.. image:: https://github.com/Dih5/vfd/raw/master/demo.png

Also check http://github.com/dih5/vfd/tree/master/external for tools to use it from other applications.


* Free software: LGPLv3+
* Documentation: https://vfd.readthedocs.io.


Features
--------
* Describe and plot:
* Scatter plots
* Error bars
* Color maps (from arrays of 2D data)
* Multiple plots in one file
* Two *x* or *y* axes in the same plot
* GUI, CLI and python package to plot the files with matplotlib.
* API mimicking matplotlib's to generate files without changing your code.
* File format will be always backward-compatible. While version < 1.0.0, CLI and API might change.

Instalation
-----------
To install the latest release, assuming you have a Python_ distribution with pip_::

$ pip install vfd
.. _Python: http://www.python.org/
.. _pip: https://pip.pypa.io/en/stable/installing/

Windows users with no interest in Python might use the deployed installer_ instead.

.. _installer: https://github.com/Dih5/vfd/releases/latest

If you want to enable bash autocompletion add ``eval "$(_VFD_COMPLETE=source vfd)"`` to your ``.bashrc`` file.


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

0.3.1 (2018-07-09)
------------------
* Improve GUI
* Added Windows installer
* Few minor improvements and fixes.

0.3.0 (2018-07-03)
------------------

* Added GUI.
* Added minimal twin axes support.
* Added xlsx export.
* Work with UTF8 in Python2.
* Some minor improvements and fixes.

0.2.0 (2018-06-08)
------------------

* Added multiplot support.
* Added colorplot support.
* Added builder module.
* Many minor improvements and fixes.


0.1.0 (2018-04-08)
------------------

* First release on PyPI.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
vfd-0.3.2-py2.py3-none-any.whl (51.2 kB) Copy SHA256 hash SHA256 Wheel py2.py3
vfd-0.3.2.tar.gz (61.9 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page