Skip to content

Commit

Permalink
Create CommandLineInterface.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yannrichet committed Mar 14, 2015
1 parent 41e8759 commit b02c232
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions CommandLineInterface.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
You can use JMathPlot in CLI to plot the content of ASCII files (same way that XMGrace). You just need to get jplot.sh for Linux/MacOS/Solaris or jplot.bat for Windows, and jmathplot.jar in the same directory.

```
Usage: jplot.<sh|bat> <-2D|-3D> [-l <INVISIBLE|NORTH|SOUTH|EAST|WEST>] [options] <ASCII file (n rows, m columns)> [[options] other ASCII file]
[-l <INVISIBLE|NORTH|SOUTH|EAST|WEST>] giving the legend position
[options] are:
-t <SCATTER|LINE|BAR|HISTOGRAM2D(<integer h>)|HISTOGRAM3D(<integer h>,<integer k>)|GRID3D|CLOUD2D(<integer h>,<integer k>)|CLOUD3D(<integer h>,<integer k>,<integer l>)> type of the plot
SCATTER|LINE|BAR: each line of the ASCII file contains coordinates of one point.
HISTOGRAM2D(<integer h>): ASCII file contains the 1D sample (i.e. m=1) to split in h slices.
HISTOGRAM3D(<integer h>,<integer k>): ASCII file contains the 2D sample (i.e. m=2) to split in h*k slices (h slices on X axis and k slices on Y axis).
GRID3D: ASCII file is a matrix, first row gives n X grid values, first column gives m Y grid values, other values are Z values.
CLOUD2D(<integer h>,<integer k>): ASCII file contains the 2D sample (i.e. m=2) to split in h*k slices (h slices on X axis and k slices on Y axis), density of cloud corresponds to frequency of X-Y slice in given 2D sample.
CLOUD3D(<integer h>,<integer k>,<integer l>): ASCII file contains the 3D sample (i.e. m=3) to split in h*k*l slices (h slices on X axis, k slices on Y axis, l slices on Y axis), density of cloud corresponds to frequency of X-Y-Z slice in given 3D sample.
-n name name of the plot
-v <ASCII file (n,3|2)> vector data to add to the plot
-q<X|Y|Z>(<float Q>) <ASCII file (n,1)> Q-quantile to add to the plot on <X|Y|Z> axis. Each line of the given ASCII file contains the value of quantile for probvability Q.
-qP<X|Y|Z> <ASCII file (n,p)> p-quantiles density to add to the plot on <X|Y|Z> axis. Each line of the given ASCII file contains p values.
-qN<X|Y|Z> <ASCII file (n,1)> Gaussian density to add to the plot on <X|Y|Z> axis. Each line of the given ASCII file contains a standard deviation.
```

Example: jplot.<sh|bat> -3D -l SOUTH -t SCATTER tmp.dat

0 comments on commit b02c232

Please sign in to comment.