From 7ef1c65b99bfb41230a45474ebdec1a359a4c455 Mon Sep 17 00:00:00 2001
From: Administrator <and.debol@srcc.msu.ru>
Date: Fri, 8 Dec 2023 23:56:24 +0000
Subject: [PATCH] Update README.md

---
 README.md | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 86071f2..005a73b 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@ Python plot tools for nse projects.
 Clone current repository and go the downloaded directory
 
 ```shell
-git clone http://tesla.parallel.ru/Lizzzka007/plotter-nse
+git clone http://tesla.parallel.ru/Lizzzka007/plotter-nse.git
 cd plotter-nse
 ```
 
@@ -154,6 +154,24 @@ Optional arguments:
 4. float or [float] $`mval`$
 5. bool or [bool] $`transpose`$
 
+### Plotting slices of 3D data
+```python
+plotter.slice(filename, plane, slice_position)
+```
+Function  saves `plane` slice contour plots of  3D data contained in file `filename` into the *out/oname* file.
+
+Positional arguments:
+1. string $`filename`$
+2. string $`plane`$ can be `xy`, `xz`, `yz`
+3. float $`slice_position`$ 
+
+Optional arguments:
+1. string $`out`$
+2. string or [string] $`oname`$
+3. string or [string] $`var`$
+4. float or [float] $`mval`$
+5. bool or [bool] $`transpose`$
+
 ### Plotting difference of N-d data
 ```python
 plotter.plot_diff(filename, ndim)
-- 
GitLab