Merge pull request #357 from naik-aakash/cli_updates

Cli updates

Author: naik-aakash

docs/reference/cli.rst

@@ -9,6 +9,7 @@ CLI Reference
    cli_subcommands/descriptionquality
    cli_subcommands/plotauto
    cli_subcommands/plotautoia
+   cli_subcommands/plotbwdf
    cli_subcommands/plotdos
    cli_subcommands/ploticohpdistance
    cli_subcommands/plot

docs/reference/cli_subcommands/plotbwdf.rst

@@ -0,0 +1,15 @@
+plot-bwdf
+==========
+
+Plot BWDFs using ICOHPs or ICOOPs or ICOBIs with respect to bond lengths.
+
+.. hint:: Aliases available
+
+   - plotbwdf
+
+.. argparse::
+   :module: lobsterpy.cli
+   :func: get_parser
+   :prog: lobsterpy
+   :path: plot-bwdf
+

docs/tutorial/commandlineinterface.rst

@@ -270,6 +270,14 @@ You can plot COHPs/COBIs/COOPs from the command line.
 
 .. image:: tutorial_assets/ICOHPs_distance_example.png
 
+-  ``lobsterpy plot-bwdf`` will plot Bond Weighted Distribution function (BWDF) using ICOHPs, ICOOPs or ICOBIs as weights against bond lengths. Example output plot is shown below. For more details on BWDFs check the orignal publication : `https://doi.org/10.1002/anie.201404223 <https://doi.org/10.1002/anie.201404223>`_
+
+.. code:: bash
+
+    lobsterpy plot-bwdf
+
+.. image:: tutorial_assets/example_bwdf.png
+
 5. Additional Options
 ~~~~~~~~~~~~~~~~~~~~~
 
@@ -297,6 +305,10 @@ either of these commands:
 
    lobsterpy description-quality --help
 
+.. code:: bash
+
+   lobsterpy plot-bwdf --help
+
 .. code:: bash
 
    lobsterpy plot-dos --help