Skip to content

Commit

Permalink
Rename CLI from cdl to datalab for consistency
Browse files Browse the repository at this point in the history
Fixes #102

(cherry picked from commit 2a2fd84)
  • Loading branch information
PierreRaybaut committed Nov 5, 2024
1 parent 1623667 commit 2135c15
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 12 deletions.
20 changes: 10 additions & 10 deletions doc/features/general/command.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@ Command line features

.. meta::
:description: DataLab command line features
:keywords: command line, cdl, datalab, run, test, demo
:keywords: command line, datalab, run, test, demo

Run DataLab
-----------

To run DataLab from the command line, type the following::

$ cdl
$ datalab

To show help on command line usage, simply run::

$ cdl --help
$ datalab --help
usage: app.py [-h] [-b path] [-v] [--unattended] [--screenshot] [--delay DELAY] [--xmlrpcport PORT]
[--verbose {quiet,minimal,normal}]
[h5]
Expand Down Expand Up @@ -46,24 +46,24 @@ Open HDF5 file at startup

To open HDF5 files, or even import only a specified HDF5 dataset, use the following::

$ cdl /path/to/file1.h5
$ cdl /path/to/file1.h5,/path/to/dataset1
$ cdl /path/to/file1.h5,/path/to/dataset1;/path/to/file2.h5,/path/to/dataset2
$ datalab /path/to/file1.h5
$ datalab /path/to/file1.h5,/path/to/dataset1
$ datalab /path/to/file1.h5,/path/to/dataset1;/path/to/file2.h5,/path/to/dataset2

Open HDF5 browser at startup
----------------------------

To open the HDF5 browser at startup, use one of the following commands::

$ cdl -b /path/to/file1.h5
$ cdl --h5browser /path/to/file1.h5
$ datalab -b /path/to/file1.h5
$ datalab --h5browser /path/to/file1.h5

Run DataLab demo
----------------

To execute DataLab demo, run the following::

$ cdl-demo
$ datalab-demo

.. _run_scientific_validation_tests:

Expand Down Expand Up @@ -94,6 +94,6 @@ Run interactive tests

To execute DataLab interactive tests, run the following::

$ cdl-tests
$ datalab-tests

.. image:: /images/interactive_tests.png
5 changes: 3 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,9 @@ Documentation = "https://datalab-platform.com/"

[project.gui-scripts]
cdl = "cdl.app:run"
cdl-demo = "cdl.tests.scenarios.demo:run"
cdl-tests = "cdl.tests:run"
datalab = "cdl.app:run"
datalab-demo = "cdl.tests.scenarios.demo:run"
datalab-tests = "cdl.tests:run"

[project.optional-dependencies]
qt = ["PyQt5"]
Expand Down

0 comments on commit 2135c15

Please sign in to comment.