diff --git a/README.md b/README.md index 6003649d37b4023142d7d978c0ffa023efadcc90..95854aa21bc09954f4bf925460cb6459f623239f 100644 --- a/README.md +++ b/README.md @@ -33,10 +33,7 @@ import plotter ``` ### get variable names from file -Use `plotter.dump(filename)` to get variable names in file `filename`. -Data must be stored either in *Tecplot* ASCII file with *.plt* or *.nsx* extensions. - -Positional arguments for functions `plotter.plot, plotter.ani_plot, plotter.plot_contour, plotter.avg_plot`: +Positional arguments for functions `plotter.dump, plotter.plot, plotter.ani_plot, plotter.plot_contour, plotter.avg_plot`: <ol> <li>filename</li> </ol> @@ -51,6 +48,9 @@ Optional arguments for functions `plotter.plot, plotter.ani_plot, plotter.plot_c The argument `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`. `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). `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. +Use `plotter.dump(filename)` to get variable names in file `filename`. +Data must be stored either in *Tecplot* ASCII file with *.plt* or *.nsx* extensions. + ### plotting a 1D data Calling ```python