# Expyplot

Inspired by this project:, but I wanted something more transparent.

<b>Documentation can be found at</b> [](

Expyplot allows you to use 'all' of the functions in matplotlib.pyplot (in reality, there are some that I left out because they don't make any sense in this context, or
are deprecated).

Unfortunately, I have not tested anywhere near all of the functions, but they should mostly work. If any don't work, please open an issue, or better yet,
make a fix and open a pull request! This library is simple enough that you should be able to grok it without too much effort.

Perhaps the most limiting thing about this library is that it currently has to convert return values from the matplotlib functions into strings before
sending them back to Elixir, so rather than returning `true`, you will get `"True"`, and good luck piecing back to gether complicated objects. The reason I went this route
is that JSON is unable to parse pretty much any complicated data type that comes back from a matplotlib function, and I didn't feel like writing a JSON parser. If you
want to do something about it, please by all means, write a JSON parser capable of serializing all the different return types from matplotlib functions: the python
side of this library is very simple - it is located in priv/

## Differences

Unfortunately (or rather, fortunately if we are celebrating linguistic diversity!), I could not attain complete transparency. This is a list of some notable differences
between this library and the real matplotlib.pyplot:

- Return values are strings currently
- Variable arguments must be wrapped in a list, so: `plt.plot(a, b)` becomes `Plot.plot([a, b])`, <b>but especially notice:</b> `Plot.plot([[1..10], other_args])`
- Named args and keyword args are atoms: `Plot.grid(b: true)`, though they don't have to be, so: `Plot.plot([[1..10], "r+"])`
- Keyword args that are not keyword only arguments must be written with keywords, you can't do them positionally, so while `plt.grid(True)` works in Python,
  you have to name the argument in Elixir: `Plot.grid(b: true)`; if you ever get the error: "argument error: :erlang.++(something, [])", this is the reason. You need
  to rewrite the argument list as a keyword list.
- Any keyword argument or named argument that starts with a capital letter needs to be renamed with an underscore: `Fs` -> `:_Fs`

## Installation

<b>You must have python3 installed and in your path</b>

<b>You must also pip3 install PyQt5:</b>
`pip3 install PyQt5`, or however you install packages for python3 on your particular system.

If this fails, it may be because you are missing Qt. You will need to do this on Ubuntu:

sudo apt-get install qt5-default qttools5-dev-tools

and on Mac OS X, do this:

brew install qt5

Expyplot works in Unix systems (tested on OSX and Ubuntu headless), but does not quite yet work on Windows. I hope to have it working on Windows very soon though.

def deps do
  [{:expyplot, "~> 1.1.2"}]

## Examples

Examples taken from and then rewritten in Elixir to use this Expyplot.

To run the examples, start an iex -S mix session and run:

Code.load_file "./path/to/example/EXAMPLE.exs"

### Histogram

defmodule HistogramExample do
  alias Expyplot.Plot

  {mu, sigma} = {100, 15}
  x = 1..10_000 |> -> Statistics.Distributions.Normal.rand(mu, sigma) end) |> Enum.to_list

  Plot.hist(x, bins: 50, normed: 1, facecolor: :green, alpha: 0.75)
  Plot.title("IQ Scores")
  Plot.axis_set([40, 160, 0, 0.03])
  Plot.grid(b: true)

### Subplots

defmodule SpectralExample do
  alias Expyplot.Plot

  dt = 0.01
  fs = 1 / dt
  t = Stream.unfold(0, fn(acc) -> {acc, acc + dt} end) |> Stream.take_while(&(&1 < 10)) |> Enum.to_list
  nse = t |> -> Statistics.Distributions.Normal.rand() end) |> Enum.to_list
  r = t |> &1 / 0.05)))

  cnse = nse |> * Enum.random(r))) |> Enum.take(length(t)) # fake convolution. I didn't feel like writing a functional convolution.
  s = t |> * Statistics.Math.pi * &1))) |> |> {el1, el2} -> el1 + el2 end)

  Plot.subplot([3, 2, 1])
  Plot.plot([t, s])

  Plot.subplot([3, 2, 1])
  Plot.plot([t, s])

  Plot.subplot([3, 2, 3])
  Plot.magnitude_spectrum(s, _Fs: fs)

  Plot.subplot([3, 2, 4])
  Plot.magnitude_spectrum(s, _Fs: fs, scale: :dB)

  Plot.subplot([3, 2, 5])
  Plot.angle_spectrum(s, _Fs: fs)

  Plot.subplot([3, 2, 6])
  Plot.phase_spectrum(s, _Fs: fs)

### Zorder/Scatterplots

defmodule ZorderExample do
  alias Expyplot.Plot

  x = 1..20 |> -> Statistics.Distributions.Normal.rand() end) |> Enum.to_list
  y = 1..20 |> -> Statistics.Distributions.Normal.rand() end) |> Enum.to_list

  Plot.subplot([2, 1, 1])
  Plot.plot([x, y, :r], [lw: 3])
  Plot.scatter(x, y, [s: 120])
  Plot.title("Lines on top of dots")

  Plot.subplot([2, 1, 2])
  Plot.plot([x, y, :r], [zorder: 1, lw: 3])
  Plot.scatter(x, y, [s: 120], [zorder: 2])
  Plot.title("Dots on top of lines")

### Bar Graph

defmodule BarExample do
  alias Expyplot.Plot

  men_means = [20, 35, 30, 35, 27]
  women_means = [25, 32, 34, 20, 25]
  men_std = [2, 3, 4, 1, 2]
  women_std = [3, 5, 2, 3, 3]
  ind = 0..4
  width = 0.35
  yticks = Stream.unfold(0, fn(acc) -> {acc, acc + 10} end) |> Stream.take_while(&(&1 < 81)) |> Enum.to_list, men_means, [width: width], color: "#d62728", yerr: men_std, label: "Men"), women_means, [width: width, bottom: men_means], yerr: women_std, label: "Women")
  Plot.title("Scores by group and gender")
  Plot.xticks([ind, {"G1", "G2", "G3", "G4", "G5"}])
![Bar Graph](images/bar.png)