| 1 |
.. _ref-to-command-line-features: |
| 2 |
|
| 3 |
Command line features |
| 4 |
===================== |
| 5 |
|
| 6 |
.. meta:: |
| 7 |
:description: DataLab command line features |
| 8 |
:keywords: command line, datalab, run, test, demo |
| 9 |
|
| 10 |
Run DataLab |
| 11 |
----------- |
| 12 |
|
| 13 |
To run DataLab from the command line, type the following:: |
| 14 |
|
| 15 |
$ datalab |
| 16 |
|
| 17 |
To show help on command line usage, simply run:: |
| 18 |
|
| 19 |
$ datalab --help |
| 20 |
usage: app.py [-h] [-b path] [-v] [--unattended] [--screenshot] [--delay DELAY] [--xmlrpcport PORT] |
| 21 |
[--verbose {quiet,minimal,normal}] |
| 22 |
[h5] |
| 23 |
|
| 24 |
Run DataLab |
| 25 |
|
| 26 |
positional arguments: |
| 27 |
h5 HDF5 file names (separated by ';'), optionally with dataset name (separated by ',') |
| 28 |
|
| 29 |
options: |
| 30 |
-h, --help show this help message and exit |
| 31 |
-b path, --h5browser path |
| 32 |
path to open with HDF5 browser |
| 33 |
-v, --version show DataLab version |
| 34 |
--reset reset DataLab configuration |
| 35 |
--unattended non-interactive mode |
| 36 |
--accept_dialogs accept dialogs in unattended mode |
| 37 |
--screenshot automatic screenshots |
| 38 |
--delay DELAY delay (ms) before quitting application in unattended mode |
| 39 |
--xmlrpcport XMLRPCPORT |
| 40 |
XML-RPC port number |
| 41 |
--verbose {quiet,normal,debug} |
| 42 |
verbosity level: for debugging/testing purpose |
| 43 |
|
| 44 |
Open HDF5 file at startup |
| 45 |
------------------------- |
| 46 |
|
| 47 |
To open HDF5 files, or even import only a specified HDF5 dataset, use the following:: |
| 48 |
|
| 49 |
$ datalab /path/to/file1.h5 |
| 50 |
$ datalab /path/to/file1.h5,/path/to/dataset1 |
| 51 |
$ datalab /path/to/file1.h5,/path/to/dataset1;/path/to/file2.h5,/path/to/dataset2 |
| 52 |
|
| 53 |
Open HDF5 browser at startup |
| 54 |
---------------------------- |
| 55 |
|
| 56 |
To open the HDF5 browser at startup, use one of the following commands:: |
| 57 |
|
| 58 |
$ datalab -b /path/to/file1.h5 |
| 59 |
$ datalab --h5browser /path/to/file1.h5 |
| 60 |
|
| 61 |
Run DataLab demo |
| 62 |
---------------- |
| 63 |
|
| 64 |
To execute DataLab demo, run the following:: |
| 65 |
|
| 66 |
$ datalab-demo |
| 67 |
|
| 68 |
.. _run_scientific_validation_tests: |
| 69 |
|
| 70 |
Run technical validation tests |
| 71 |
------------------------------- |
| 72 |
|
| 73 |
.. note:: Technical validation tests are directly included in individual unit tests |
| 74 |
and are disseminated throughout the code. The test functions including validation |
| 75 |
tests are marked with the ``@pytest.mark.validation`` decorator. |
| 76 |
|
| 77 |
To execute DataLab technical validation tests, run the following:: |
| 78 |
|
| 79 |
$ pytest -m validation |
| 80 |
|
| 81 |
.. seealso:: See section :ref:`validation` for more information on DataLab's validation strategy. |
| 82 |
|
| 83 |
.. _run_functional_validation_tests: |
| 84 |
|
| 85 |
Run complete test suite |
| 86 |
------------------------ |
| 87 |
|
| 88 |
To execute all DataLab unit tests, simply run:: |
| 89 |
|
| 90 |
$ pytest |
| 91 |
|
| 92 |
Run interactive tests |
| 93 |
--------------------- |
| 94 |
|
| 95 |
To execute DataLab interactive tests, run the following:: |
| 96 |
|
| 97 |
$ datalab-tests |
| 98 |
|
| 99 |
.. image:: /images/interactive_tests.png |