diff --git a/README.md b/README.md index 86071f221c3366490fc6413ec958356c22ee40bb..005a73b31d8ae2e67b938d5ffb25ee96b7bf7a57 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)