From bbc2b625bfc495709cbbe79cd428767c98f2d1ab Mon Sep 17 00:00:00 2001 From: Matthew Bourque Date: Tue, 21 Aug 2018 17:03:29 -0400 Subject: [PATCH 1/3] Fixed overline that was too short. --- docs/source/monitor_filesystem.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/monitor_filesystem.rst b/docs/source/monitor_filesystem.rst index 50c6a3df6..017ddaef0 100755 --- a/docs/source/monitor_filesystem.rst +++ b/docs/source/monitor_filesystem.rst @@ -1,6 +1,6 @@ -*********** +****************** monitor_filesystem -*********** +****************** .. automodule:: jwql.monitor_filesystem.monitor_filesystem :members: From 4b7a0ea99c30fad2865af070fb67f6b58a6490fb Mon Sep 17 00:00:00 2001 From: Matthew Bourque Date: Tue, 21 Aug 2018 17:17:16 -0400 Subject: [PATCH 2/3] Fixed overline issue with monitor_mast sphinx docs --- docs/source/monitor_mast.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/monitor_mast.rst b/docs/source/monitor_mast.rst index 5a263b0e4..f4e3a9775 100644 --- a/docs/source/monitor_mast.rst +++ b/docs/source/monitor_mast.rst @@ -1,6 +1,6 @@ -********* +************ monitor_mast -********* +************ .. automodule:: jwql.monitor_mast.monitor_mast :members: From c700a031f7e3f5e87a028f3a4777243b311d7fdc Mon Sep 17 00:00:00 2001 From: Matthew Bourque Date: Tue, 21 Aug 2018 17:17:43 -0400 Subject: [PATCH 3/3] Fixed indentation issue to appease Sphinx docs --- jwql/monitor_filesystem/monitor_filesystem.py | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/jwql/monitor_filesystem/monitor_filesystem.py b/jwql/monitor_filesystem/monitor_filesystem.py index 8b8c45f02..1c1b1d509 100755 --- a/jwql/monitor_filesystem/monitor_filesystem.py +++ b/jwql/monitor_filesystem/monitor_filesystem.py @@ -15,29 +15,31 @@ --- This module can be executed from the command line: + :: python monitor_filesystem.py Alternatively, it can be called from scripts with the following import statements: + :: - from monitor_filesystem import filesystem_monitor - from monitor_filesystem import plot_system_stats + from monitor_filesystem import filesystem_monitor + from monitor_filesystem import plot_system_stats Required arguments (in a ``config.json`` file): ``filepath`` - The path to the input file needs to be in a - ``config.json`` file in the ``utils`` directory + ``config.json`` file in the ``utils`` directory ``outputs`` - The path to the output files needs to be in a - ``config.json`` file in the ``utils`` directory. + ``config.json`` file in the ``utils`` directory. Required arguments for plotting: ``inputfile`` - The name of the file to save all of the system - statistics to + statistics to ``filebytype`` - The name of the file to save stats on fits type - files to + files to Dependencies @@ -281,7 +283,7 @@ def plot_system_stats(stats_file, filebytype, sizebytype): output_file(outfile) save(grid) set_permissions(outfile) - + # Begin logging: logging.info("Completed.")