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.

Source Distribution

vfd-0.3.2.tar.gz (61.9 kB view details)

Uploaded Source

Built Distribution

vfd-0.3.2-py2.py3-none-any.whl (51.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file vfd-0.3.2.tar.gz.

File metadata

  • Download URL: vfd-0.3.2.tar.gz
  • Upload date:
  • Size: 61.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.6.3

File hashes

Hashes for vfd-0.3.2.tar.gz
Algorithm Hash digest
SHA256 0d946ddf324c3ef429f521b631eac4709aadb146e507a8fd7ffada2328936bb9
MD5 6a326113019f6761b64c88393e30bf92
BLAKE2b-256 1d66b57a8bb61a264ae6b91da66c3b1c0c09a615650e48d09b961d27cceac9d0

See more details on using hashes here.

File details

Details for the file vfd-0.3.2-py2.py3-none-any.whl.

File metadata

  • Download URL: vfd-0.3.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 51.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.6.3

File hashes

Hashes for vfd-0.3.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 52910eabc075819a67dfcede30e0b264ef02aec32ad73300633d887e4f65b54c
MD5 da816fb9644dc9db9820b007592218aa
BLAKE2b-256 185ae526c38270822da5def62375619f6909a41b2f76e2586db0d2a75ac46a4e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page