From 420ad4cbd8e701207b120920f8407b11930e795d Mon Sep 17 00:00:00 2001 From: Elizabeth Gashchuk <gashchuk2011@mail.ru> Date: Sun, 10 Dec 2023 12:42:48 +0000 Subject: [PATCH] Update README.md --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 005a73b..d93958d 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ import plotter - `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 -- `transpose` if True flips the axis, default = False +- `ifTranspose` if True flips the axis, default = False ### Get variable names from file ```python @@ -80,6 +80,7 @@ Optional arguments: 2. string $`oname`$ 3. string $`var`$ 4. float $`mval`$ +5. bool $`ifTranspose`$ Function saves XY plots of 1D data contained in file `filename` into *out/oname* file. @@ -100,7 +101,7 @@ Optional arguments: 4. float or [float] $`mval`$ 5. float $`min\_y`$ 6. float $`max\_y`$ -7. bool or [bool] $`transpose`$ +7. bool $`ifTranspose`$ ### Plotting a 2D data ```python @@ -118,7 +119,7 @@ Optional arguments: 4. float or [float] $`mval`$ 5. float or [float] $`min\_y`$ 6. float or [float] $`max\_y`$ -7. bool or [bool] $`transpose`$ +7. bool $`transpose`$ ### Plotting animation of a 2D data ```python @@ -136,7 +137,7 @@ Optional arguments: 4. float or [float] $`mval`$ 5. float or [float] $`min\_y`$ 6. float or [float] $`max\_y`$ -7. bool or [bool] $`transpose`$ +7. bool $`ifTranspose`$ ### Plotting an averaged by x and y coordinates 3D data ```python @@ -152,7 +153,7 @@ Optional arguments: 2. string or [string] $`oname`$ 3. string or [string] $`var`$ 4. float or [float] $`mval`$ -5. bool or [bool] $`transpose`$ +5. bool $`ifTranspose`$ ### Plotting slices of 3D data ```python @@ -170,7 +171,7 @@ Optional arguments: 2. string or [string] $`oname`$ 3. string or [string] $`var`$ 4. float or [float] $`mval`$ -5. bool or [bool] $`transpose`$ +5. bool $`ifTranspose`$ ### Plotting difference of N-d data ```python @@ -187,3 +188,4 @@ Optional arguments: 2. string or [string] $`oname`$ 3. string or [string] $`var`$ 4. float or [float] $`mval`$ +5. bool $`ifTranspose`$ -- GitLab