From cc20dc12ec2fda6bd937d4e4156118fc87ab581e Mon Sep 17 00:00:00 2001 From: Sandrine Avakian Date: Tue, 7 Jan 2014 11:55:34 +0100 Subject: [PATCH] Adding docs in cortexlab. --- sfa/cortexlab/cortexlabnodes.py | 44 +++- sfa/cortexlab/docs/Makefile | 153 ++++++++++++++ sfa/cortexlab/docs/source/conf.py | 255 ++++++++++++++++++++++++ sfa/cortexlab/docs/source/cortexlab.rst | 59 ++++++ sfa/cortexlab/docs/source/index.rst | 74 +++++++ sfa/cortexlab/docs/source/modules.rst | 7 + 6 files changed, 581 insertions(+), 11 deletions(-) create mode 100644 sfa/cortexlab/docs/Makefile create mode 100644 sfa/cortexlab/docs/source/conf.py create mode 100644 sfa/cortexlab/docs/source/cortexlab.rst create mode 100644 sfa/cortexlab/docs/source/index.rst create mode 100644 sfa/cortexlab/docs/source/modules.rst diff --git a/sfa/cortexlab/cortexlabnodes.py b/sfa/cortexlab/cortexlabnodes.py index 15ef6e62..a264b4ea 100644 --- a/sfa/cortexlab/cortexlabnodes.py +++ b/sfa/cortexlab/cortexlabnodes.py @@ -1,6 +1,15 @@ """ File used to handle all the nodes querying: -- get nodes list along with their properties +* get nodes list along with their properties with get_all_nodes + +* get sites and their properties with get_sites. + +* get nodes involved in leases sorted by lease id, with get_reserved_nodes. + +* create a lease (schedule an experiment) with schedule_experiment. + +* delete a lease with delete_experiment. + """ class CortexlabQueryNodes: @@ -12,11 +21,9 @@ class CortexlabQueryNodes: """ Get all the nodes and their properties. Called by GetNodes. Filtering on nodes properties can be done here or in GetNodes. - Search for specific nodes if some filters are - specified.Returns all the nodes properties if no return_fields_list - given. - TODO: Define which properties have to be listed here. Useful ones: - node architecture, radio type, position (x,y,z) + Search for specific nodes if some filters are specified. Returns all + the nodes properties if return_fields_list is None. + :param node_filter_dict: dictionary of lists with node properties. For instance, if you want to look for a specific node with its hrn, @@ -27,11 +34,15 @@ class CortexlabQueryNodes: :type return_fields_list: list :returns: list of dictionaries with node properties :rtype: list + + TODO: Define which properties have to be listed here. Useful ones: + node architecture, radio type, position (x,y,z) """ node_dict_list = None # Get the nodes here, eventually filter here # See iotlabapi.py GetNodes to get the filtering (node_filter_dict and # return_fields_list ) part, if necessary + # Format used in iotlab node_dict_list = [ {'hrn': 'iotlab.wsn430-11.devlille.iot-lab.info', 'archi': 'wsn430', 'mobile': 'True', @@ -69,6 +80,7 @@ class CortexlabQueryNodes: :param return_fields_list: fields that has to be returned :type site_filter_name_list: list :type return_fields_list: list + :rtype: list of dictionaries """ site_dict_list = None site_dict_list = [ @@ -93,25 +105,34 @@ class CortexlabQueryNodes: :param username: user's LDAP login :type username: string :returns: list of reservations dict - :rtype: dict list + :rtype: list of dictionaries """ reserved_nodes_list_dict = None + + reserved_nodes_list_dict = [{'lease_id': 1658, + 'reserved_nodes': [ 'wsn430-11.devlille.iot-lab.info'], 'state': + 'Waiting', 'user': 'avakian', 'resource_ids': [11], + 't_from': 1412938800, 't_until': 1412942640}] + return reserved_nodes_list_dict def schedule_experiment(self, lease_dict): """Schedule/ run an experiment based on the information provided in the lease dictionary. - :param lease_dict: contains lease_start_time, - lease_duration, added_nodes, slice_name , slice_user, grain: + :param lease_dict: contains lease_start_time, lease_duration, + added_nodes, slice_name , slice_user, grain: :type lease_dict: dictionary - + :rtype: dict """ answer = {} answer['id'] = None #experiment id answer['msg'] = None #message in case of error + + answer['id'] = 1659 + # Launch the experiment here return answer @@ -126,6 +147,7 @@ class CortexlabQueryNodes: :param experiment_id: experiment identifier :type experiment_id : integer :param username: user's LDAP login + :type experiment_id: integer :type username: string :returns: dict with delete status {'status': True of False} :rtype: dict @@ -134,4 +156,4 @@ class CortexlabQueryNodes: # depending if the delete was effective or not. ret = {} ret['status'] = None - return ret \ No newline at end of file + return ret diff --git a/sfa/cortexlab/docs/Makefile b/sfa/cortexlab/docs/Makefile new file mode 100644 index 00000000..fa5a75b4 --- /dev/null +++ b/sfa/cortexlab/docs/Makefile @@ -0,0 +1,153 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + -rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/cortexlab_sfa_driver.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/cortexlab_sfa_driver.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/cortexlab_sfa_driver" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/cortexlab_sfa_driver" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." diff --git a/sfa/cortexlab/docs/source/conf.py b/sfa/cortexlab/docs/source/conf.py new file mode 100644 index 00000000..ecea4ac8 --- /dev/null +++ b/sfa/cortexlab/docs/source/conf.py @@ -0,0 +1,255 @@ +# -*- coding: utf-8 -*- +# +# cortexlab_sfa_driver documentation build configuration file, created by +# sphinx-quickstart on Mon Nov 18 12:11:50 2013. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +sys.path.insert(0, os.path.abspath('../../')) +sys.path.insert(0, os.path.abspath('../../../')) +sys.path.insert(0, os.path.abspath('../../../storage/')) +sys.path.insert(0, os.path.abspath('../../../../')) +sys.path.insert(0, os.path.abspath('../../../rspecs/elements/versions/')) +sys.path.insert(0, os.path.abspath('../../../rspecs/elements/')) +sys.path.insert(0, os.path.abspath('../../../importer/')) +print sys.path + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Cortexlab SFA driver' +copyright = u'2013, Sandrine Avakian' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '0.1' +# The full version, including alpha/beta/rc tags. +release = '0.1' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'cortexlab_sfa_driverdoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'cortexlab_sfa_driver.tex', u'cortexlab\\_sfa\\_driver Documentation', + u'Sandrine Avakian', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'cortexlab_sfa_driver', u'cortexlab_sfa_driver Documentation', + [u'Sandrine Avakian'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------------ + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'cortexlab_sfa_driver', u'cortexlab_sfa_driver Documentation', + u'Sandrine Avakian', 'cortexlab_sfa_driver', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/sfa/cortexlab/docs/source/cortexlab.rst b/sfa/cortexlab/docs/source/cortexlab.rst new file mode 100644 index 00000000..a8e3ca4e --- /dev/null +++ b/sfa/cortexlab/docs/source/cortexlab.rst @@ -0,0 +1,59 @@ +cortexlab Package +================= + +:mod:`LDAPapi` Module +--------------------- + +.. automodule:: cortexlab.LDAPapi + :members: + :undoc-members: + :show-inheritance: + +:mod:`cortexlabaggregate` Module +-------------------------------- + +.. automodule:: cortexlab.cortexlabaggregate + :members: + :undoc-members: + :show-inheritance: + +:mod:`cortexlabdriver` Module +----------------------------- + +.. automodule:: cortexlab.cortexlabdriver + :members: + :undoc-members: + :show-inheritance: + +:mod:`cortexlabnodes` Module +---------------------------- + +.. automodule:: cortexlab.cortexlabnodes + :members: + :undoc-members: + :show-inheritance: + +:mod:`cortexlabpostgres` Module +------------------------------- + +.. automodule:: cortexlab.cortexlabpostgres + :members: + :undoc-members: + :show-inheritance: + +:mod:`cortexlabshell` Module +---------------------------- + +.. automodule:: cortexlab.cortexlabshell + :members: + :undoc-members: + :show-inheritance: + +:mod:`cortexlabslices` Module +----------------------------- + +.. automodule:: cortexlab.cortexlabslices + :members: + :undoc-members: + :show-inheritance: + diff --git a/sfa/cortexlab/docs/source/index.rst b/sfa/cortexlab/docs/source/index.rst new file mode 100644 index 00000000..d0343d04 --- /dev/null +++ b/sfa/cortexlab/docs/source/index.rst @@ -0,0 +1,74 @@ +.. cortexlab_sfa_driver documentation master file, created by + sphinx-quickstart on Mon Nov 18 12:11:50 2013. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to cortexlab_sfa_driver's documentation! +================================================ + +=================== +Code tree overview +=================== + +------ +Driver +------ + +The Cortexlab driver source code is under the folder /sfa, along with the other +testbeds driver folders. The /cortexlab directory contains the necessary files +defining API for LDAP, the postgresql database as well as for the SFA +managers. + + +Cortexlabnodes +--------------- + +CortexlabQueryTestbed class's goal is to get information from the testbed +about the site and its nodes. +There are two types of information about the nodes: + +* their properties : hostname, radio type, position, site, node_id and so on. + (For a complete list of properties, please refer to the method + get_all_nodes in cortexlabnodes.py). + +* their availability, whether the node is currently in use, in a scheduled experiment + in the future or available. The availability of the nodes can be managed by a + scheduler or a database. The node's availabity status is modified when it is + added to/ deleted from an experiment. In SFA, this corresponds to + creating/deleting a lease involving this node. + +Currently, CortexlabQueryTestbed is merely a skeleton of methods that have to be +implemented with the real testbed API in order to provide the functionality +they were designed for. + + +In the LDAP file, the LDAPapi class is based on the unix schema. +If this class is reused in another context, it might not work without some bit +of customization. The naming (turning a hostname into a sfa hrn, a LDAP login +into a hrn ) is also done in this class. + +The cortexlabpostgres file defines a dedicated cortexlab database, separated from the +SFA database. Its purpose is to hold information that we can't store anywhere +given the Cortexlab architecture with OAR and LDAP, namely the association of a +job and the slice hrn for which the job is supposed to run. Indeed, one user +may register on another federated testbed then use his federated slice to book +cortexlab nodes. In this case, an Cortexlab LDAP account will be created. Later on, +when new users will be imported from the LDAP to the SFA database, a Cortexlab +slice will be created for each new user found in the LDAP. Thus leading us to +the situation where one user may have the possibility to use different slices +to book Cortexlab nodes. + +Contents: + +.. toctree:: + :maxdepth: 2 + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/sfa/cortexlab/docs/source/modules.rst b/sfa/cortexlab/docs/source/modules.rst new file mode 100644 index 00000000..19c4cd79 --- /dev/null +++ b/sfa/cortexlab/docs/source/modules.rst @@ -0,0 +1,7 @@ +cortexlab +========= + +.. toctree:: + :maxdepth: 4 + + cortexlab -- 2.45.2