Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/acorbe/autogpy
Gnuplot scripts and figures auto-generated in Python. Production-ready, Latex and Tikz rendering.
https://github.com/acorbe/autogpy
gnuplot gnuplot-graphs gnuplot-interface jupyter numpy plotting-in-python python3 tikz
Last synced: 2 days ago
JSON representation
Gnuplot scripts and figures auto-generated in Python. Production-ready, Latex and Tikz rendering.
- Host: GitHub
- URL: https://github.com/acorbe/autogpy
- Owner: acorbe
- License: bsd-3-clause
- Created: 2019-05-16T09:33:32.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-10-29T09:10:53.000Z (about 4 years ago)
- Last Synced: 2025-01-16T00:11:59.889Z (8 days ago)
- Topics: gnuplot, gnuplot-graphs, gnuplot-interface, jupyter, numpy, plotting-in-python, python3, tikz
- Language: Python
- Homepage: https://acorbe.github.io/autogpy/
- Size: 3.72 MB
- Stars: 9
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
autogpy - AutoGnuplot.py
Automatic generation of gnuplot figures/scripts/data from python.
**Author:** [Alessandro Corbetta](http://corbetta.phys.tue.nl/), 2019-2020
**Documentation:** https://acorbe.github.io/autogpy/
**Examples** [Link](https://github.com/acorbe/autogpy/tree/master/examples)
**Github** [Link](https://github.com/acorbe/autogpy)
[](https://pypi.org/project/autogpy/) [](https://travis-ci.org/github/acorbe/autogpy) [](https://pepy.tech/project/autogpy)
### Which problem does it solve? [](https://colab.research.google.com/github/acorbe/autogpy/blob/master/examples/05-colab/Autogpy_colab_showcase.ipynb)
`autogpy` eliminates annoying duplications of code and data when employing python for data analysis and [gnuplot](http://www.gnuplot.info/) for figures. Providing a gnuplot-like or a matplotlib-like syntax, `autogpy` automatically generates gnuplot scripts and dumps suitably the data.
Links: [[Source](https://github.com/acorbe/autogpy/tree/master/examples/02-webexample/webmovie.ipynb)] [[Output](https://github.com/acorbe/autogpy/tree/master/examples/02-webexample/test-figure)]
### Main features
+ [[Reference](https://acorbe.github.io/autogpy/code.html#autogpy.AutoGnuplotFigure.plot)] [[Example 1](https://github.com/acorbe/autogpy/blob/master/examples/01-syntax/hybrid-python-gnuplot-syntax.ipynb) [2](https://github.com/acorbe/autogpy/blob/master/examples/01-syntax/pure-gnuplot-syntax.ipynb)] anything that be obtained by the gnuplot command `plot` can be produced
+ output figures are shipped in a folder which includes scripts, data and makefile
+ any gnuplot state modification can be achieved
+ terminals epslatex, tikz/pgfplot and jpg
+ multiplots
+ `plt.hist`-like gnuplot histogram figures generator
+ jupyter notebook figure preview
+ jupyter notebook gnuplot script inspection
+ easy scp-based synchronization between a machine in which the figures are generated (e.g. from even larger datasets) and the "paper writing" machine.
**Requirements**
+ Linux/MacOs (could work on Windows, yet it has not been adjusted for)
+ Python 3
+ Working latex distribution
+ Gnuplot, optionally with tikz terminal (tikz terminal requires a working installation of luatex)
+ `pdftoppm` (via [`poppler-utils`](https://command-not-found.com/pdftoppm)) or [`imagemagick`](https://command-not-found.com/convert) to convert the output pdf figures in png format for jupyter notebook preview
+ **Note:** in case `pdftoppm` is unavailable, `imagemagick` offline conversions pdf to png must be enabled (`sudo sed -i '/PDF/s/none/read|write/' /etc/ImageMagick-6/policy.xml`) [[Reference](https://stackoverflow.com/a/52661288)]
### Getting autogpy
Via `pip`
```bash
pip install autogpy
```
On Google Colab
```bash
!apt install gnuplot texlive poppler-utils ghostscript texlive-latex-extra
!pip install autogpy
```
From source
```bash
git clone [email protected]:acorbe/autogpy.git
pip install autogpy/
```
## In a nutshell
Please see also the [examples](https://github.com/acorbe/autogpy/tree/master/examples) and the [documentation](https://acorbe.github.io/autogpy/).
```python
import autogpy
import numpy as np
xx = np.linspace(0,6,100)
yy = np.sin(xx)
zz = np.cos(xx)
with autogpy.AutogpyFigure("test_figure") as figure:
# gnuplot-like syntax
figure.plot(r'with lines t "sin"',xx,yy)
# matplotlib-like syntax
figure.plot(xx,zz,u='1:2',w='lines',label='cos')
```
generates the following figure (also appearing in jupyter)
**Most importantly**, the following source and data are created in the folder `test_figure`
```bash
$ ls test_figure
.gitignore
Makefile
sync_me.sh
fig__0__.dat
fig__1__.dat
fig__.core.gnu
fig__.jpg.gnu
fig__.pdflatex_compile.sh
fig__.pdflatex.gnu
fig__.tikz_compile.sh
fig__.tikz.gnu
```
With `make` one can obtain jpg, epslatex, and tikz/pgfplot versions of the figure. Notice that the input data has been formatted automatically and dumped in the `.dat` files.
Inspecting the `fig__.pdflatex.gnu`, responsible of the epslatex version of the figure, one gets:
```gnuplot
set terminal epslatex size 9.9cm,8.cm color colortext standalone 'phv,12 ' linewidth 2
set output 'fig.latex.nice/plot_out.tex'
p "fig__0__.dat" with lines t "sin",\
"fig__1__.dat" u 1:2 with lines t "cos"
```
**KWONW ISSUES**
+ Certain features require imagemagick and a working `gnuplot-tikz.lua`. Some versions of these might have bugs. Call `figure.display_fixes()` to show known fixes.