pgfplots 0.2.0

A Rust library to generate publication-quality figures
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

# PGFPlots

[![Test Status](https://github.com/DJDuque/pgfplots/actions/workflows/rust.yml/badge.svg)](https://github.com/DJDuque/pgfplots/actions/workflows/rust.yml)
[![Crates.io](https://img.shields.io/crates/v/pgfplots?labelColor=383f47)](https://crates.io/crates/pgfplots)
[![GitHub commits since latest release (by date)](https://img.shields.io/github/commits-since/DJDuque/pgfplots/latest?labelColor=383f47)](https://github.com/DJDuque/pgfplots/commits/main)

A Rust library to generate publication-quality figures. This crate is a PGFPlots
code generator, and provides utilities to create, customize, and compile 
high-quality plots.

## Usage

Add the following to your `Cargo.toml` file:

```toml
[dependencies]
pgfplots = { version = "0.2", features = ["inclusive"] }
```

Plotting a quadratic function is as simple as:

```rust
use pgfplots::axis::plot::Plot2D;

let mut plot = Plot2D::new();
plot.coordinates = (-100..100)
    .into_iter()
    .map(|i| (f64::from(i), f64::from(i*i)).into())
    .collect();

plot.show()?;
```

## Features

- Inclusive: Allow users to process the LaTeX code that generates figures
without relying on any externally installed software, configuration, or
resource files. This is achieved by including the
[tectonic](https://crates.io/crates/tectonic) crate as a dependency.

	If you already have a LaTeX distribution installed in your system, it is
recommended not to use this feature and process the LaTeX code directly; this
will significantly reduce compilation and processing times. Plotting a quadratic
function is still very simple:

	```rust
	use pgfplots::axis::plot::Plot2D;
	use std::process::{Command, Stdio};

	let mut plot = Plot2D::new();
	plot.coordinates = (-100..100)
		.into_iter()
		.map(|i| (f64::from(i), f64::from(i*i)).into())
		.collect();

	let argument = plot.standalone_string().replace('\n', "").replace('\t', "");
	Command::new("pdflatex")
		.stdout(Stdio::null())
		.stderr(Stdio::null())
		.arg("-interaction=batchmode")
		.arg("-halt-on-error")
		.arg("-jobname=figure")
		.arg(argument)
		.status();
	```

## Want to contribute?

There are multiple ways to contribute:
- Install and test PGFPlots. If it doesn't work as expected please [open an
  issue](https://github.com/DJDuque/pgfplots/issues/new).
- Comment/propose a fix on some of the current [open 
issues](https://github.com/DJDuque/pgfplots/issues).
- Read through the [documentation](https://docs.rs/pgfplots). If there is 
  something confusing, or you have a suggestion for something that could be 
  improved, please let the maintainer(s) know.
- Help evaluate [open pull requests](https://github.com/DJDuque/pgfplots/pulls),
  by testing locally and reviewing what is proposed.