# plotter-python
Python plot tools for nse projects.

## Installation
Clone current repository and go the downloaded directory

```shell
git clone http://tesla.parallel.ru/Lizzzka007/plotter-nse
cd plotter-nse
```

Install it with *pip*
```shell
pip install .
```

Sometimes `pip` refers to *Python 2* package manaager, not *Python 3*. 
In this case install the package with
```shell
python3 -m pip install .
```

Install it with *conda*
```shell
conda develop .
```
## Usage

Data must be stored either in *Tecplot* ASCII file with *.plt* or *.nsx* extensions. 

After installation you can use *plotter-python* tools in your python scripts.  
Import *plotter* module somewhere at the beginning of your script
```python
import plotter
```

### Functions argument description
Positional arguments for functions `plotter.dump, plotter.plot, plotter.ani_plot, plotter.plot_contour, plotter.avg_plot`:
<ol>
  <li>filename</li>
</ol>

Optional arguments for functions `plotter.plot, plotter.ani_plot, plotter.plot_contour, plotter.avg_plot`:
<ol>
  <li>out</li>
  <li>oname</li>
  <li>var</li>
  <li>mval</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. 

### 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

Calling 
```python
plotter.ani_plot(filename)
```
saves animation of XY plots of 1D data contained in file `filename` into *out/oname* file.

### Plotting a 2D data
Calling 
```python
plotter.plot_contour(filename)
```
saves XY contour plots of 2D data contained in file `filename` into *out/oname* file.

### 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.