Merge pull request #202 from SAR-ARD/feature/s1ard_s1rb

renamed the command line tool from s1ard to s1rb

docs/source/general/usage.rst

@@ -273,32 +273,33 @@ Command Line Interface
 ----------------------
 Once a configuration file has been created and all of its parameters have been properly defined, it can be used to start
 the processor using the command line interface (CLI) tool provided with the s1ard package.
+The tool `s1rb` can be used to create the two radar backscatter products NRB and ORB.
 
 The following options are currently available.
 
 Print a help message for the CLI tool:
 
 ::
 
-    s1ard --help
+    s1rb --help
 
 Print the processor version:
 
 ::
 
-    s1ard --version
+    s1rb --version
 
 Start the processor using parameters defined in the default section of a ``config.ini`` file:
 
 ::
 
-    s1ard -c /path/to/config.ini
+    s1rb -c /path/to/config.ini
 
 Start the processor using parameters defined in section ``SECTION_NAME`` of a ``config.ini`` file:
 
 ::
 
-    s1ard -c /path/to/config.ini -s SECTION_NAME
+    s1rb -c /path/to/config.ini -s SECTION_NAME
 
 Start the processor using parameters defined in the default section of a ``config.ini`` file but
 override some parameters, e.g. ``acq_mode`` and ``annotation``:

pyproject.toml

@@ -35,4 +35,4 @@ readme = { file = ["README.md"], content-type = "text/markdown" }
 [tool.setuptools_scm]
 
 [project.scripts]
-s1ard = "s1ard.cli:cli"
+s1rb = "s1ard.cli:cli"

s1ard/cli.py

@@ -1,7 +1,7 @@
 import click
 
 
-@click.command(name='s1ard',
+@click.command(name='s1rb',
                no_args_is_help=True,
                context_settings=dict(
                    ignore_unknown_options=True,
@@ -18,17 +18,17 @@
 @click.pass_context
 def cli(ctx, config_file, section, debug, version):
     """
-    Central s1ard processing command.
+    Central s1ard radar backscatter (rb) processing command.
     
     Additional options can be passed to override individual processing parameters
     in the configuration file. For example, to read all values from the configuration
     file except the acquisition mode and the annotation layers:
     
-    s1ard -c config.ini --acq_mode IW --annotation dm,id
+    s1rb -c config.ini --acq_mode IW --annotation dm,id
     
     The snap_gpt_args argument can be provided by using a dedicated argument separator and quotes:
     
-    s1ard -c config.ini -- --snap_gpt_args "-J-Xmx100G -c 75G -q 30"
+    s1rb -c config.ini -- --snap_gpt_args "-J-Xmx100G -c 75G -q 30"
     
     \b
     The following defaults are set: