diff --git a/README.md b/README.md index ee545afaed6878ad4a261015048ac2a4f9e078b4..86071f221c3366490fc6413ec958356c22ee40bb 100644 --- a/README.md +++ b/README.md @@ -44,6 +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 ### Get variable names from file ```python @@ -97,8 +98,9 @@ Optional arguments: 2. string $`oname`$ 3. string or [string] $`var`$ 4. float or [float] $`mval`$ -5. float $`min_y`$ -6. float $`max_y`$ +5. float $`min\_y`$ +6. float $`max\_y`$ +7. bool or [bool] $`transpose`$ ### Plotting a 2D data ```python @@ -114,12 +116,13 @@ Optional arguments: 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`$ +5. float or [float] $`min\_y`$ +6. float or [float] $`max\_y`$ +7. bool or [bool] $`transpose`$ ### Plotting animation of a 2D data ```python -plotter.plot_contour(filename) +plotter.ani_plot_contour(filename) ``` Function saves XY contour plots of 2D data contained in file `filename` into the *out/oname* file. @@ -131,8 +134,9 @@ Optional arguments: 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`$ +5. float or [float] $`min\_y`$ +6. float or [float] $`max\_y`$ +7. bool or [bool] $`transpose`$ ### Plotting an averaged by x and y coordinates 3D data ```python @@ -148,6 +152,7 @@ Optional arguments: 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