- (beta) added a '--suppress-cursor' option to remove the spinning wh…

…eel when it is not needed - fixed documentation text and comments
mazzalab · Aug 27, 2018 · d68c0e4 · d68c0e4
1 parent 284deb2
commit d68c0e4
Show file tree

Hide file tree

Showing 58 changed files with 124 additions and 87 deletions.
diff --git a/algorithms/bruteforce_search.py b/algorithms/bruteforce_search.py
@@ -5,7 +5,7 @@
 """
 
 __author__ = ["Daniele Capocefalo", "Mauro Truglio", "Tommaso Mazza"]
-__copyright__ = "Copyright 2018, The pyntacle Project"
+__copyright__ = "Copyright 2018, The Pyntacle Project"
 __credits__ = ["Ferenc Jordan"]
 __version__ = "0.2.3.1"
 __maintainer__ = "Daniele Capocefalo"

diff --git a/algorithms/global_topology.py b/algorithms/global_topology.py
@@ -1,7 +1,7 @@
 """ Compute several global topology metrics of a given graph """
 
 __author__ = ["Daniele Capocefalo", "Mauro Truglio", "Tommaso Mazza"]
-__copyright__ = "Copyright 2018, The pyntacle Project"
+__copyright__ = "Copyright 2018, The Pyntacle Project"
 __credits__ = ["Ferenc Jordan"]
 __version__ = "0.2.3.1"
 __maintainer__ = "Daniele Capocefalo"

diff --git a/algorithms/greedy_optimization.py b/algorithms/greedy_optimization.py
@@ -5,7 +5,7 @@
 """
 
 __author__ = ["Daniele Capocefalo", "Mauro Truglio", "Tommaso Mazza"]
-__copyright__ = "Copyright 2018, The pyntacle Project"
+__copyright__ = "Copyright 2018, The Pyntacle Project"
 __credits__ = ["Ferenc Jordan"]
 __version__ = "0.2.3.1"
 __maintainer__ = "Daniele Capocefalo"

diff --git a/algorithms/keyplayer.py b/algorithms/keyplayer.py
@@ -2,7 +2,7 @@
 https://doi.org/10.1007/s10588-006-7084-x"""
 
 __author__ = ["Daniele Capocefalo", "Mauro Truglio", "Tommaso Mazza"]
-__copyright__ = "Copyright 2018, The pyntacle Project"
+__copyright__ = "Copyright 2018, The Pyntacle Project"
 __credits__ = ["Ferenc Jordan"]
 __version__ = "0.2.3.1"
 __maintainer__ = "Daniele Capocefalo"

diff --git a/algorithms/local_topology.py b/algorithms/local_topology.py
@@ -3,7 +3,7 @@
 """
 
 __author__ = ["Daniele Capocefalo", "Mauro Truglio", "Tommaso Mazza"]
-__copyright__ = "Copyright 2018, The pyntacle Project"
+__copyright__ = "Copyright 2018, The Pyntacle Project"
 __credits__ = ["Ferenc Jordan"]
 __version__ = "0.2.3.1"
 __maintainer__ = "Daniele Capocefalo"

diff --git a/algorithms/scalefree_inference.py b/algorithms/scalefree_inference.py
@@ -1,5 +1,5 @@
 __author__ = "Daniele Capocefalo, Mauro Truglio, Tommaso Mazza"
-__copyright__ = "Copyright 2018, The pyntacle Project"
+__copyright__ = "Copyright 2018, The Pyntacle Project"
 __credits__ = ["Ferenc Jordan"]
 __version__ = "0.2.3.1"
 __maintainer__ = "Daniele Capocefalo"

diff --git a/algorithms/shortest_path.py b/algorithms/shortest_path.py
@@ -3,7 +3,7 @@
 """
 
 __author__ = ["Daniele Capocefalo", "Mauro Truglio", "Tommaso Mazza"]
-__copyright__ = "Copyright 2018, The pyntacle Project"
+__copyright__ = "Copyright 2018, The Pyntacle Project"
 __credits__ = ["Ferenc Jordan"]
 __version__ = "0.2.3.1"
 __maintainer__ = "Tommaso Mazza"

diff --git a/algorithms/shortestpath_gpu.py b/algorithms/shortestpath_gpu.py
@@ -2,7 +2,7 @@
 a NVIDIA-compliant GPU, if available"""
 
 __author__ = "Daniele Capocefalo, Mauro Truglio, Tommaso Mazza"
-__copyright__ = "Copyright 2018, The pyntacle Project"
+__copyright__ = "Copyright 2018, The Pyntacle Project"
 __credits__ = ["Ferenc Jordan"]
 __version__ = "0.2.3.1"
 __maintainer__ = "Tommaso Mazza"

diff --git a/algorithms/sparseness.py b/algorithms/sparseness.py
@@ -7,7 +7,7 @@
 
 
 __author__ = "Daniele Capocefalo, Mauro Truglio, Tommaso Mazza"
-__copyright__ = "Copyright 2018, The pyntacle Project"
+__copyright__ = "Copyright 2018, The Pyntacle Project"
 __credits__ = ["Ferenc Jordan"]
 __version__ = "0.2.3.1"
 __maintainer__ = "Daniele Capocefalo"

diff --git a/cmds/cmds_utils/kpsearch_wrapper.py b/cmds/cmds_utils/kpsearch_wrapper.py
@@ -1,5 +1,5 @@
 __author__ = "Daniele Capocefalo, Mauro Truglio, Tommaso Mazza"
-__copyright__ = "Copyright 2018, The pyntacle Project"
+__copyright__ = "Copyright 2018, The Pyntacle Project"
 __credits__ = ["Ferenc Jordan"]
 __version__ = "0.2.3.1"
 __maintainer__ = "Daniele Capocefalo"

diff --git a/cmds/cmds_utils/plotter.py b/cmds/cmds_utils/plotter.py
@@ -1,5 +1,5 @@
 __author__ = "Daniele Capocefalo, Mauro Truglio, Tommaso Mazza"
-__copyright__ = "Copyright 2018, The pyntacle Project"
+__copyright__ = "Copyright 2018, The Pyntacle Project"
 __credits__ = ["Ferenc Jordan"]
 __version__ = "0.2.3.1"
 __maintainer__ = "Daniele Capocefalo"

diff --git a/cmds/cmds_utils/reporter.py b/cmds/cmds_utils/reporter.py
@@ -1,5 +1,5 @@
 __author__ = "Daniele Capocefalo, Mauro Truglio, Tommaso Mazza"
-__copyright__ = "Copyright 2018, The pyntacle Project"
+__copyright__ = "Copyright 2018, The Pyntacle Project"
 __credits__ = ["Ferenc Jordan"]
 __version__ = "0.2.3.1"
 __maintainer__ = "Daniele Capocefalo"

diff --git a/cmds/communities.py b/cmds/communities.py
@@ -1,5 +1,5 @@
 __author__ = "Daniele Capocefalo, Mauro Truglio, Tommaso Mazza"
-__copyright__ = "Copyright 2018, The pyntacle Project"
+__copyright__ = "Copyright 2018, The Pyntacle Project"
 __credits__ = ["Ferenc Jordan"]
 __version__ = "0.2.3.1"
 __maintainer__ = "Daniele Capocefalo"
@@ -48,9 +48,12 @@ def __init__(self, args):
             self.args.no_plot = True
 
     def run(self):
-        cursor = CursorAnimation()
-        cursor.daemon = True
-        cursor.start()
+
+        if not self.args.suppress_cursor:
+            cursor = CursorAnimation()
+            cursor.daemon = True
+            cursor.start()
+
         if not self.args.input_file:
             sys.stderr.write("ERROR: Input file is missing. Quitting\n")
             sys.exit(1)
@@ -410,6 +413,8 @@ def run(self):
                     sys.stdout.write(
                         "Module {0} is above pyntacle Plotting limits ({1} nodes , we support 1000 nodes). Will skip plotting this module.\n".format(
                             i, comm.vcount()))
-        cursor.stop()
+        if not self.args.suppress_cursor:
+            cursor.stop()
+
         sys.stdout.write("Community Finding completed successfully. Ending\n")
         sys.exit(0)
diff --git a/cmds/convert.py b/cmds/convert.py
@@ -1,5 +1,5 @@
 __author__ = "Daniele Capocefalo, Mauro Truglio, Tommaso Mazza"
-__copyright__ = "Copyright 2018, The pyntacle Project"
+__copyright__ = "Copyright 2018, The Pyntacle Project"
 __credits__ = ["Ferenc Jordan"]
 __version__ = "0.2.3.1"
 __maintainer__ = "Daniele Capocefalo"
@@ -32,17 +32,19 @@
 
 class Convert():
     """
-    take input command line arguments in order to quickly convert one file format to another
+    take input network file and convert one file format to another (with several options attached)
     """
     def __init__(self, args):
         self.logging = log
         self.args = args
 
     def run(self):
         # dictionary that stores the basename of the output file
-        cursor = CursorAnimation()
-        cursor.daemon = True
-        cursor.start()
+        if not self.args.suppress_cursor:
+            cursor = CursorAnimation()
+            cursor.daemon = True
+            cursor.start()
+
         if self.args.no_header:
             header = False
         else:
@@ -150,6 +152,8 @@ def run(self):
                         os.path.abspath(self.args.input_file), output_path))
                 PyntacleExporter.Binary(graph, output_path)
 
-            cursor.stop()
+            if not self.args.suppress_cursor:
+                cursor.stop()
+
             sys.stdout.write("{} converted successfully\n".format(os.path.basename(self.args.input_file)))
             sys.exit(0)
diff --git a/cmds/generate.py b/cmds/generate.py
@@ -1,5 +1,5 @@
 __author__ = "Daniele Capocefalo, Mauro Truglio, Tommaso Mazza"
-__copyright__ = "Copyright 2018, The pyntacle Project"
+__copyright__ = "Copyright 2018, The Pyntacle Project"
 __credits__ = ["Ferenc Jordan"]
 __version__ = "0.2.3.1"
 __maintainer__ = "Daniele Capocefalo"
@@ -42,9 +42,11 @@ def __init__(self, args):
             random.seed(self.args.seed)
 
     def run(self):
-        cursor = CursorAnimation()
-        cursor.daemon = True
-        cursor.start()
+        if not self.args.suppress_cursor:
+            cursor = CursorAnimation()
+            cursor.daemon = True
+            cursor.start()
+
         if self.args.which == "random":
 
             if self.args.nodes is None:
@@ -373,7 +375,10 @@ def run(self):
                 "Graph ({} nodes) exceeds pyntacle limits for plotting (maximum 1000 nodes). Will not draw Graph".format(
                     graph.vcount()))
             sys.exit(0)
-        cursor.stop()
+
+        if not self.args.suppress_cursor:
+            cursor.stop()
+
         sys.stdout.write("pyntacle Generate completed successfully. Ending\n")
         if self.args.repeat == 1:
             sys.exit(0)
diff --git a/cmds/keyplayer.py b/cmds/keyplayer.py
@@ -1,5 +1,5 @@
 __author__ = "Daniele Capocefalo, Mauro Truglio, Tommaso Mazza"
-__copyright__ = "Copyright 2018, The pyntacle Project"
+__copyright__ = "Copyright 2018, The Pyntacle Project"
 __credits__ = ["Ferenc Jordan"]
 __version__ = "0.2.3.1"
 __maintainer__ = "Daniele Capocefalo"
@@ -50,9 +50,11 @@ def __init__(self, args):
             self.args.no_plot = True
 
     def run(self):
-        cursor = CursorAnimation()
-        cursor.daemon = True
-        cursor.start()
+        if not self.args.suppress_cursor:
+            cursor = CursorAnimation()
+            cursor.daemon = True
+            cursor.start()
+
         if self.args.m_reach == None and self.args.type in ["pos", "all"]:
             raise Error("m reach distance must be provided")
 
@@ -606,6 +608,8 @@ def run(self):
 
         elif graph.vcount() >= 1000:
             sys.stdout.write("The graph has too many nodes ({}). Can't draw graph\n".format(graph.vcount()))
-        cursor.stop()
+        if not self.args.suppress_cursor:
+            cursor.stop()
+
         sys.stdout.write("pyntacle Keyplayer completed successfully. Ending\n")
         sys.exit(0)
diff --git a/cmds/metrics.py b/cmds/metrics.py
@@ -1,5 +1,5 @@
 __author__ = "Daniele Capocefalo, Mauro Truglio, Tommaso Mazza"
-__copyright__ = "Copyright 2018, The pyntacle Project"
+__copyright__ = "Copyright 2018, The Pyntacle Project"
 __credits__ = ["Ferenc Jordan"]
 __version__ = "0.2.3.1"
 __maintainer__ = "Daniele Capocefalo"
@@ -53,9 +53,10 @@ def __init__(self, args):
             self.args.no_plot = True
 
     def run(self):
-        cursor = CursorAnimation()
-        cursor.daemon = True
-        cursor.start()
+        if not self.args.suppress_cursor:
+            cursor = CursorAnimation()
+            cursor.daemon = True
+            cursor.start()
         if self.args.no_header:
             header = False
         else:
@@ -473,6 +474,8 @@ def run(self):
             sys.stdout.write("Saving graph to a Binary file\n")
             PyntacleExporter.Binary(graph, binary_path)
 
-        cursor.stop()
+        if not self.args.suppress_cursor:
+            cursor.stop()
+
         sys.stdout.write("pyntacle Metrics completed successfully. Ending\n")
         sys.exit(0)
diff --git a/cmds/set.py b/cmds/set.py
@@ -1,5 +1,5 @@
 __author__ = "Daniele Capocefalo, Mauro Truglio, Tommaso Mazza"
-__copyright__ = "Copyright 2018, The pyntacle Project"
+__copyright__ = "Copyright 2018, The Pyntacle Project"
 __credits__ = ["Ferenc Jordan"]
 __version__ = "0.2.3.1"
 __maintainer__ = "Daniele Capocefalo"
@@ -53,10 +53,11 @@ def __init__(self, args):
             self.args.no_plot = True
 
     def run(self):
-        # process input files
-        cursor = CursorAnimation()
-        cursor.daemon = True
-        cursor.start()
+
+        if not self.args.suppress_cursor:
+            cursor = CursorAnimation()
+            cursor.daemon = True
+            cursor.start()
         if not self.args.input_file_1 or not self.args.input_file_2:
             sys.stderr.write("ERROR: one of the two input files is missing. Quitting\n")
             sys.exit(1)
@@ -436,6 +437,9 @@ def run(self):
         reporter1.report.extend(reporter2.report)
         reporter1.report.extend(reporter_final.report)
         reporter1.write_report(report_dir=self.args.directory, format=self.args.report_format)
-        cursor.stop()
+
+        if not self.args.suppress_cursor:
+            cursor.stop()
+
         sys.stdout.write("pyntacle Set completed successfully\n")
         sys.exit(0)
diff --git a/config.py b/config.py
@@ -1,5 +1,5 @@
 __author__ = ["Daniele Capocefalo", "Mauro Truglio", "Tommaso Mazza"]
-__copyright__ = "Copyright 2018, The pyntacle Project"
+__copyright__ = "Copyright 2018, The Pyntacle Project"
 __credits__ = ["Ferenc Jordan"]
 __version__ = "0.2.3.1"
 __maintainer__ = "Daniele Capocefalo"

diff --git a/exceptions/generic_error.py b/exceptions/generic_error.py
@@ -1,5 +1,5 @@
 __author__ = "Daniele Capocefalo, Mauro Truglio, Tommaso Mazza"
-__copyright__ = "Copyright 2018, The pyntacle Project"
+__copyright__ = "Copyright 2018, The Pyntacle Project"
 __credits__ = ["Ferenc Jordan"]
 __version__ = "0.2.3.1"
 __maintainer__ = "Daniele Capocefalo"

diff --git a/exceptions/illegal_argument_number_error.py b/exceptions/illegal_argument_number_error.py
@@ -3,7 +3,7 @@
 """
 
 __author__ = "Daniele Capocefalo, Mauro Truglio, Tommaso Mazza"
-__copyright__ = "Copyright 2018, The pyntacle Project"
+__copyright__ = "Copyright 2018, The Pyntacle Project"
 __credits__ = ["Ferenc Jordan"]
 __version__ = "0.2.3.1"
 __maintainer__ = "Daniele Capocefalo"

diff --git a/exceptions/illegal_graph_size_error.py b/exceptions/illegal_graph_size_error.py
@@ -3,7 +3,7 @@
 """
 
 __author__ = "Daniele Capocefalo, Mauro Truglio, Tommaso Mazza"
-__copyright__ = "Copyright 2018, The pyntacle Project"
+__copyright__ = "Copyright 2018, The Pyntacle Project"
 __credits__ = ["Ferenc Jordan"]
 __version__ = "0.2.3.1"
 __maintainer__ = "Daniele Capocefalo"

diff --git a/exceptions/illegal_kppset_size_error.py b/exceptions/illegal_kppset_size_error.py
@@ -3,7 +3,7 @@
 """
 
 __author__ = "Daniele Capocefalo, Mauro Truglio, Tommaso Mazza"
-__copyright__ = "Copyright 2018, The pyntacle Project"
+__copyright__ = "Copyright 2018, The Pyntacle Project"
 __credits__ = ["Ferenc Jordan"]
 __version__ = "0.2.3.1"
 __maintainer__ = "Daniele Capocefalo"

diff --git a/exceptions/missing_attribute_error.py b/exceptions/missing_attribute_error.py
@@ -3,7 +3,7 @@
 """
 
 __author__ = "Daniele Capocefalo, Mauro Truglio, Tommaso Mazza"
-__copyright__ = "Copyright 2018, The pyntacle Project"
+__copyright__ = "Copyright 2018, The Pyntacle Project"
 __credits__ = ["Ferenc Jordan"]
 __version__ = "0.2.3.1"
 __maintainer__ = "Daniele Capocefalo"

diff --git a/exceptions/multiple_solutions_error.py b/exceptions/multiple_solutions_error.py
@@ -3,7 +3,7 @@
 """
 
 __author__ = "Daniele Capocefalo, Mauro Truglio, Tommaso Mazza"
-__copyright__ = "Copyright 2018, The pyntacle Project"
+__copyright__ = "Copyright 2018, The Pyntacle Project"
 __credits__ = ["Ferenc Jordan"]
 __version__ = "0.2.3.1"
 __maintainer__ = "Daniele Capocefalo"

diff --git a/exceptions/notagraph_error.py b/exceptions/notagraph_error.py
@@ -3,7 +3,7 @@
 """
 
 __author__ = "Daniele Capocefalo, Mauro Truglio, Tommaso Mazza"
-__copyright__ = "Copyright 2018, The pyntacle Project"
+__copyright__ = "Copyright 2018, The Pyntacle Project"
 __credits__ = ["Ferenc Jordan"]
 __version__ = "0.2.3.1"
 __maintainer__ = "Daniele Capocefalo"

diff --git a/exceptions/unproperly_formatted_file_error.py b/exceptions/unproperly_formatted_file_error.py
@@ -3,7 +3,7 @@
 """
 
 __author__ = "Daniele Capocefalo, Mauro Truglio, Tommaso Mazza"
-__copyright__ = "Copyright 2018, The pyntacle Project"
+__copyright__ = "Copyright 2018, The Pyntacle Project"
 __credits__ = ["Ferenc Jordan"]
 __version__ = "0.2.3.1"
 __maintainer__ = "Daniele Capocefalo"

diff --git a/exceptions/unsupported_graph_error.py b/exceptions/unsupported_graph_error.py
@@ -3,7 +3,7 @@
 """
 
 __author__ = "Daniele Capocefalo, Mauro Truglio, Tommaso Mazza"
-__copyright__ = "Copyright 2018, The pyntacle Project"
+__copyright__ = "Copyright 2018, The Pyntacle Project"
 __credits__ = ["Ferenc Jordan"]
 __version__ = "0.2.3.1"
 __maintainer__ = "Daniele Capocefalo"