add a plot_network method using NetworkX as backende (#275)

* Added plot_network_x function to plots.py folder

* Added plot_network_x function to plots.py folder

* reorganize the plots module

* update documentation

* add tests

* new lock

---------

Co-authored-by: LegrandNico <[email protected]>

Author: LouieMH

docs/source/api.rst

@@ -203,18 +203,32 @@ Plots
 *****
 
 Plotting functionalities to visualize parameters trajectories and correlations after
-observing new data.
+observing new data. We are currently fully supporting Graphviz. NetworkX is also
+available for some functions.
 
-.. currentmodule:: pyhgf.plots
+Graphviz
+========
+
+.. currentmodule:: pyhgf.plots.graphviz
 
 .. autosummary::
-   :toctree: generated/pyhgf.plots
+   :toctree: generated/pyhgf.plots.graphviz
 
    plot_trajectories
    plot_correlations
    plot_network
    plot_nodes
 
+Networkx
+========
+
+.. currentmodule:: pyhgf.plots.networkx
+
+.. autosummary::
+   :toctree: generated/pyhgf.plots.networkx
+
+   plot_network
+
 Response
 ********
 

poetry.lock

@@ -17,7 +17,7 @@
     add_ef_state,
     get_couplings,
 )
-from pyhgf.plots import plot_correlations, plot_network, plot_nodes, plot_trajectories
+from pyhgf.plots import graphviz, networkx
 from pyhgf.typing import Attributes, Edges, NetworkParameters, UpdateSequence
 from pyhgf.utils import (
     add_edges,
@@ -473,19 +473,29 @@ def add_nodes(
 
     def plot_nodes(self, node_idxs: Union[int, List[int]], **kwargs):
         """Plot the node(s) beliefs trajectories."""
-        return plot_nodes(network=self, node_idxs=node_idxs, **kwargs)
+        return graphviz.plot_nodes(network=self, node_idxs=node_idxs, **kwargs)
 
     def plot_trajectories(self, **kwargs):
         """Plot the parameters trajectories."""
-        return plot_trajectories(network=self, **kwargs)
+        return graphviz.plot_trajectories(network=self, **kwargs)
 
     def plot_correlations(self):
         """Plot the heatmap of cross-trajectories correlation."""
-        return plot_correlations(network=self)
+        return graphviz.plot_correlations(network=self)
 
-    def plot_network(self):
+    def plot_network(self, backend: str = "graphviz"):
         """Visualization of node network using GraphViz."""
-        return plot_network(network=self)
+        if backend == "graphviz":
+            return graphviz.plot_network(network=self)
+        elif backend == "networkx":
+            return networkx.plot_network(network=self)
+        else:
+            raise ValueError(
+                (
+                    "Invalid backend."
+                    " Should be one of the following: 'graphviz' or 'networkx'",
+                )
+            )
 
     def to_pandas(self) -> pd.DataFrame:
         """Export the nodes trajectories and surprise as a Pandas data frame.