Positional arguments for functions `plotter.dump, plotter.plot, plotter.ani_plot, plotter.plot_contour, plotter.avg_plot`:
<ol>
<li>filename, type = string</li>
</ol>
Optional arguments for functions `plotter.plot, plotter.ani_plot, plotter.plot_contour, plotter.avg_plot`:
<ol>
<li>out, type = string</li>
<li>oname, type = string</li>
<li>var, type = string</li>
<li>mva, type = float</li>
</ol>
The argument `filename` is the name of a file to read for functions `plotter.plot, plotter.plot_contour, plotter.avg_plot` and the template of filenames for the function `plotter.ani_plot`. `out` is the output directory to save a function result. `oname` is the output name of a function result. `var` is a list or a single variable denoting names(name) to process (may be got from `plotter.dump` function). `mval` is a list or a single variable denoting maximum valid absolute values(value) of `var` variables: values which satisfy the condition `var` > `mval` are set as NaN.
-`filename` is the name of a file to read for functions `plotter.plot, plotter.plot_contour, plotter.avg_plot` and the template of filenames for the function `plotter.ani_plot`
-`out` is the output directory to save a function result
-`oname` is the output name of a function result
-`var` is a list or a single variable denoting names(name) to process (may be got from `plotter.dump` function)
-`mval` is a list or a single variable denoting maximum valid absolute values(value) of `var` variables: values which satisfy the condition `var` > `mval` are set as NaN.
-`min_y` is the minimum value of y-axis for the 1d plotting and the minimum value of the colorbar for the 2d plotting
-`max_y` is the maximum value of y-axis for the 1d plotting and the maximum value of the colorbar for the 2d plotting
### Get variable names from file
Use `plotter.dump(filename)` to get variable names in file `filename`.
### Plotting a 1D data
Calling
```python
plotter.plot(filename)
```
saves XY plots of 1D data contained in file `filename` into *out/oname* file.
### Plotting animation of a 1D data
Positional arguments:
1. string $`filename`$
Calling
Optional arguments:
1. string $`out`$
2. string $`oname`$
3. string $`var`$
4. float $`mval`$
Function saves XY plots of 1D data contained in file `filename` into *out/oname* file.
### Plotting animation of a 1D data
```python
plotter.ani_plot(filename)
```
saves animation of XY plots of 1D data contained in file `filename` into *out/oname* file.
Function saves animation of XY plots of 1D data contained in files with the template name`filename` into the *out/oname* file.
### Plotting a 2D data
Calling
Positional arguments:
1. string $`filename`$
Optional arguments:
1. string $`out`$
2. string $`oname`$
3. string or [string] $`var`$
4. float or [float] $`mval`$
5. float $`min_y`$
6. float $`max_y`$
### Plotting a 2D data
```python
plotter.plot_contour(filename)
```
saves XY contour plots of 2D data contained in file `filename` into *out/oname* file.
Function saves XY contour plots of 2D data contained in file `filename` into the *out/oname* file.
Positional arguments:
1. string $`filename`$
Optional arguments:
1. string $`out`$
2. string or [string] $`oname`$
3. string or [string] $`var`$
4. float or [float] $`mval`$
5. float or [float] $`min_y`$
6. float or [float] $`max_y`$
### Plotting an averaged by x and y coordinates 3D data
Calling
```python
plotter.avg_plot(filename)
```
saves XY plots of averaged 3D data contained in file `filename` into *out/oname* file.
\ No newline at end of file
Function saves XY plots of averaged 3D data contained in file `filename` into the *out/oname* file.
