Merge pull request #181 from UW-Hydro/develop

Add --version option

Author: arbennett

docs/index.rst

@@ -105,7 +105,21 @@ in the configuration files see the `configuration <configuration.rst>`_ page.
 
 Once installed, MetSim can be used from the command line via:
 
-``ms /path/to/configuration [-v] [-n #]``
+.. code-block:: bash 
+ 
+    usage: ms [-h] [-n NUM_WORKERS] [-s SCHEDULER] [-v] [--version] config
+
+    positional arguments:
+    config                Input configuration file
+
+    optional arguments:
+    -h, --help            show this help message and exit
+    -n NUM_WORKERS, --num_workers NUM_WORKERS
+                            Parallel mode: number of processes to use
+    -s SCHEDULER, --scheduler SCHEDULER
+                            Dask scheduler to use
+    -v, --verbose         Increase the verbosity of MetSim
+    --version             Name and version number
 
 Bracketed flags are optional; ``-v`` activates verbose mode to print messages
 about the status of a run, and ``-n`` activates parallelism.  The number given

docs/whats-new.rst

@@ -3,6 +3,14 @@
 What's New
 ==========
 
+.. _whats-new.2.1.1.develop:
+
+v.2.1.1.develop
+-------
+Enhancements
+~~~~~~~~~~~~
+- Allow for ``--version`` flag on command-line.
+
 .. _whats-new.2.0.1.develop:
 
 v.2.0.1.develop

metsim/cli/ms.py

@@ -38,6 +38,7 @@ def _is_valid_file(parser, arg):
 
 def parse(args):
     """Parse the command line arguments"""
+    from metsim import __name__, __version__
     parser = argparse.ArgumentParser()
     parser.add_argument('config', type=lambda x: _is_valid_file(parser, x),
                         help='Input configuration file')
@@ -47,6 +48,9 @@ def parse(args):
                         help='Dask scheduler to use')
     parser.add_argument('-v', '--verbose', action='store_true',
                         help='Increase the verbosity of MetSim')
+    parser.add_argument('--version', action='version',
+                        version='{} {}'.format(__name__, __version__),
+                        help='Name and version number')
     return parser.parse_args()