Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ulises-jeremias committed Oct 17, 2023
1 parent caee3db commit b69043e
Showing 1 changed file with 0 additions and 18 deletions.
18 changes: 0 additions & 18 deletions plot/README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,12 @@
# VSL Plot

> This is in a very early stage of development so issues are to be expected.
> The lack of features is the major problem right now, but these are slowly but
> surely going to be added. If you find any problem, please file an issue and
> we will try to solve it as soon as possible. Any suggestion is welcome!
This library implements high-level functions to generate plots and drawings.
Although we use Python/Plotly, the goal is to provide a convenient
V library that is different than Plotly. The difference happens
because we want convenience for the V developer while getting the
fantastic quality of Plotly grinning.

Internally, we use Plotly via a Python 3 script. First, we generate a
JSON files in a directory under `$VMODULES/vsl/plot`, and then
we call python3 using V's `os.execute`. The JSON file is then read
by Plotly and the plot is generated.

`vsl.plot` follows the structure of
[Plotly's graph_objects](https://plotly.com/python/graph-objects/).
Check the examples folder and compare it to Plotly's Python examples
for a better understanding.

## Dependencies

- [Python 3](https://www.python.org/)

## Supported Graph Types

- Bar
Expand Down

0 comments on commit b69043e

Please sign in to comment.