From 1a81c340659d4ce44463dde9cac10b314ede7115 Mon Sep 17 00:00:00 2001
From: Lizzzka007 <gashchuk2011@mail.ru>
Date: Thu, 22 Jun 2023 00:10:23 +0300
Subject: [PATCH] Update readme

---
 README.md | 54 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 53 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 0b16b83..ee545af 100644
--- a/README.md
+++ b/README.md
@@ -37,6 +37,7 @@ import plotter
 ### Functions argument description
 
 - `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`
+- `ndim` is the dimensionality of the data contained in `filename`
 - `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)
@@ -45,7 +46,25 @@ import plotter
 - `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`.
+```python
+plotter.dump(filename)
+```
+
+Positional arguments:
+1. string $`filename`$
+
+Function prints names of variables in file `filename`.
+
+### Get data from file 
+```python
+plotter.get_data(filename, ndim)
+```
+
+Positional arguments:
+1. string $`filename`$
+2. int $`ndim`$
+
+Function returns data contained in file `filename` as a dictionary with key values as variables names.
 
 ### Plotting a 1D data
 ```python
@@ -98,6 +117,23 @@ Optional arguments:
 5. float or [float] $`min_y`$
 6. float or [float] $`max_y`$
 
+### Plotting animation of a 2D data 
+```python
+plotter.plot_contour(filename)
+```
+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
 ```python
 plotter.avg_plot(filename)
@@ -112,3 +148,19 @@ Optional arguments:
 2. string or [string] $`oname`$
 3. string or [string] $`var`$
 4. float or [float] $`mval`$
+
+### Plotting difference of N-d data
+```python
+plotter.plot_diff(filename, ndim)
+```
+Function saves plots of the subtraction of the data contained in `filename[1]` from the data contained in `filename[0]` into the *out/oname* file.
+
+Positional arguments:
+1. [string] $`filename`$
+2. int $`ndim`$
+
+Optional arguments:
+1. string $`out`$
+2. string or [string] $`oname`$
+3. string or [string] $`var`$
+4. float or [float] $`mval`$
-- 
GitLab