Commit f7ac3cb4 authored by Jay's avatar Jay Committed by jay
Browse files

Documentation Updates

parent e99d8b5f

autocnet/control/control.py

+2 −4
Original line number Diff line number Diff line
@@ -5,6 +5,7 @@ import pandas as pd 
POINT_TYPE = 2

MEASURE_TYPE = 2





class CSeries(pd.Series):

    """

    A custom pandas series that can accept additional methods
@@ -16,10 +17,7 @@ class CSeries(pd.Series): 


class C(pd.DataFrame):

    """

    Control network.



    Parameters

    ----------

    Control network designed in the ISIS format.



    Attributes

    ----------

autocnet/fileio/io_spectral_profiler.py

+5 −4
Original line number Diff line number Diff line
@@ -11,7 +11,7 @@ class Spectral_Profiler(object): 


    """

    Attributes

    ==========

    ----------



    spectra : dict

              A dictionary with k as the integer observation id and value
@@ -29,10 +29,11 @@ class Spectral_Profiler(object): 
        Read the .spc file, parse the label, and extract the spectra



        Parameters

        ==========

        ----------



        input_data : string

                     The PATH to the input .spc file



        cleaned : boolean

                  If True, mask the data based on the QA array.

        """

autocnet/fileio/tests/test_io_json.py

0 → 100644
+0 −0

Empty file added.

autocnet/graph/network.py

+7 −3
Original line number Diff line number Diff line
@@ -326,6 +326,7 @@ class CandidateGraph(nx.Graph): 


        Returns

        -------



        filelist : list

                   A list where each entry is a string containing the full path to an image in the graph.

        """
@@ -340,6 +341,7 @@ class CandidateGraph(nx.Graph): 


        Parameters

        ----------



        clean_keys : list

             of strings identifying the masking arrays to use, e.g. ratio, symmetry
@@ -349,6 +351,7 @@ class CandidateGraph(nx.Graph): 


        Returns

        -------



        merged_cnet : C

                      A control network object

        """
@@ -474,7 +477,7 @@ class CandidateGraph(nx.Graph): 
        Write the edge structure to a JSON adjacency list



        Parameters

        ==========

        ----------



        outputfile : str

                     PATH where the JSON will be written
@@ -501,6 +504,7 @@ class CandidateGraph(nx.Graph): 


        Returns

        -------



         : list

           A list of connected sub-graphs of nodes, with the largest sub-graph first. Each subgraph is a set.

        """

autocnet/graph/tests/test_edge.py

0 → 100644
+11 −0
Original line number Diff line number Diff line 
import unittest



from .. import edge



class TestEdge(unittest.TestCase):



    def setUp(self):

        self.edge = edge.Edge(source=0, destination=1)



    def test_properties(self):

        pass
 
 No newline at end of file