Commit 33047145 authored by Flavio TARSETTI's avatar Flavio TARSETTI

Merge branch 'docedit-v2' into '1.4.x'

changed ./bin/beat to only beat

See merge request !49
parents 8d858482 a2b49103
Pipeline #24234 failed with stages
in 12 minutes and 24 seconds
......@@ -74,7 +74,7 @@ Note that it is also possible to set a different code editor
.. code-block:: sh
$ ./bin/beat config set editor vim
$ beat config set editor vim
So we can imagine using the ``edit`` command to edit locally any object.
......@@ -84,7 +84,7 @@ using the following command:
.. code-block:: sh
$ ./bin/beat algorithm edit user/integers_echo/1
$ beat algorithm edit user/integers_echo/1
You can also use the ``path`` command on all your objects to identify all
the files and local paths for any given object.
......@@ -94,7 +94,7 @@ named ``user/integers_echo/1`` using the following command:
.. code-block:: sh
$ ./bin/beat algorithm path user/integers_echo/1
$ beat algorithm path user/integers_echo/1
Local Overrides
......@@ -113,8 +113,8 @@ like this:
.. code-block:: sh
# set a different prefix when operating from the current directory
$ ./bin/beat config set --local prefix `pwd`/other_prefix
$ ./bin/beat config show
$ beat config set --local prefix `pwd`/other_prefix
$ beat config show
...
......
......@@ -121,13 +121,13 @@ There a two ways to plot data:
.. code-block:: sh
$ ./bin/beat experiments plot --remote experimentname
$ beat experiments plot --remote experimentname
* using data from the cache of locally ran experiments
.. code-block:: sh
$ ./bin/beat experiments plot experimentname
$ beat experiments plot experimentname
In both cases the 'outputfolder' option can be specified to save all the plots to a specific directory. By default, if nothing was specified, the plots will be saved under the experiment path.
......
......@@ -55,13 +55,13 @@ There a many ways to plot data:
.. code-block:: sh
$ ./bin/beat plotter plot --sample_data plottername
$ beat plotter plot --sample_data plottername
* passing some private input data (no sample_data required here), specific plotterparameter and output image name
.. code-block:: sh
$ ./bin/beat plotter plot plottername --inputdata inputdata.json --outputimage outputimage.png --plotterparameter plotterparameter
$ beat plotter plot plottername --inputdata inputdata.json --outputimage outputimage.png --plotterparameter plotterparameter
* inputdata.json is the filename containing data
* outputimage is the name of the saved image
......@@ -72,7 +72,7 @@ There a many ways to plot data:
.. code-block:: sh
$ ./bin/beat plotter plot plottername --inputdata inputdata.json --plotterparameter plotterparameter
$ beat plotter plot plottername --inputdata inputdata.json --plotterparameter plotterparameter
* The image gets saved under the plotter path with default name "output_image.png"
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment