Commit 34e84eaa authored by eric pellegrini's avatar eric pellegrini

Modified and refactored (many) docstrings for not having anymore any

warnings with sphinx
parent cd27c20d
......@@ -8,7 +8,7 @@ MDANSE_API="../MDANSE/Doc/API"
#mkdir ${MDANSE_API}/_static
#mkdir ${MDANSE_API}/_templates
sphinx-apidoc -o ${MDANSE_API} -F --separate -d 5 -H MDANSE -A "G. Goret & E. Pellegrini" -V 1.0 -R 1.0 ../MDANSE
sphinx-apidoc -o ${MDANSE_API} -F --separate -d 5 -H MDANSE -A "G. Goret & E. Pellegrini" -V 1.0 -R 1.0 ../MDANSE ../MDANSE/Externals
cp conf_html.py ${MDANSE_API}/conf.py
......
#MDANSE : Molecular Dynamics Analysis for Neutron Scattering Experiments
#------------------------------------------------------------------------------------------
#Copyright (C)
#2015- Eric C. Pellegrini Institut Laue-Langevin
#BP 156
#6, rue Jules Horowitz
#38042 Grenoble Cedex 9
#France
#pellegrini[at]ill.fr
#goret[at]ill.fr
#aoun[at]ill.fr
#
#This library is free software; you can redistribute it and/or
#modify it under the terms of the GNU Lesser General Public
#License as published by the Free Software Foundation; either
#version 2.1 of the License, or (at your option) any later version.
#
#This library is distributed in the hope that it will be useful,
#but WITHOUT ANY WARRANTY; without even the implied warranty of
#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
#Lesser General Public License for more details.
#
#You should have received a copy of the GNU Lesser General Public
#License along with this library; if not, write to the Free Software
#Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
'''
Created on Mar 30, 2015
@author: goret
'''
# import os
# import shutil
# import sys
#
# import MDANSE
# MDANSE_PATH = os.path.abspath('../MDANSE')
# sys.path.append(os.path.dirname(__file__))
#
# 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.append(MDANSE_PATH)
# DOC_PATH = os.path.join(MDANSE_PATH,'Doc')
# if not os.path.exists(DOC_PATH):
# os.makedirs(DOC_PATH)
#
# shutil.copy('mdanse_logo.png',DOC_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.viewcode', 'sphinx.ext.graphviz', 'sphinx.ext.inheritance_diagram', 'sphinx.ext.pngmath']#,'rst2pdf.pdfbuilder']
# 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'MDANSE'
copyright = u'2015, Gael Goret, Bachir Aoun and Eric C. Pellegrini'
# 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 = '1.0'
# The full version, including alpha/beta/rc tags.
release = '1.0'
html_logo = '_static/mdanse_logo.png'
inheritance_graph_attrs = dict(size='""')
inheritance_graph_attrs = dict(rankdir="TB", size='""')
inheritance_node_attrs = dict(color='lightblue', style='filled')
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# -- Options for HTML output ---------------------------------------------------
html_sidebars = {'**': ['localtoc.html','sourcelink.html', 'searchbox.html']}
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = "nature"
html_theme_options = {'sidebarwidth':250}#, 'nosidebar':True}
# Output file base name for HTML help builder.
htmlhelp_basename = 'MDANSE_doc'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'MDANSE.tex', u'MDANSE Documentation',
u'Gael Goret \\& Eric C. Pellegrini', 'manual'),
]
pdf_documents = [('index', 'MDANSE', u'MDANSE Documentation', u'Gael Goret & Eric C. Pellegrini'),]
# -- Options for manual page output --------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [('index', 'MDANSE', u'MDANSE Documentation', u'Gael Goret & Eric C. Pellegrini'),]
# 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', 'MDANSE', u'MDANSE Documentation',u'Gael Goret & Eric C. Pellegrini','MDANSE', 'One line description of project.','Miscellaneous'),]
# List of directories, relative to source directory, that shouldn't be searched
# for source files.
exclude_patterns = ['Externals']
members_to_watch = ['class']
def flag_onthefly(app, what, name, obj, options, lines):
from MDANSE import REGISTRY
for kls in REGISTRY["job"].values():
kls.__doc__ += kls.build_doc()
if(what in members_to_watch):
# and modify the docstring so the rendered output is highlights the omission
if lines:
lines.insert(0,'**Description:**\n\n')
lines.insert(0,' .. inheritance-diagram:: %s\n'%name.split('.')[-1])
lines.insert(0,'**inheritance-diagram:**\n\n')
# def setup(app):
#
# app.connect('autodoc-process-docstring', flag_onthefly)
This diff is collapsed.
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: Eric C. Pellegrini
:author: Eric C. Pellegrini
'''
import abc
......@@ -108,8 +108,6 @@ class ClassRegistry(abc.ABCMeta):
Only the classes that are metaclassed by ClassRegistry will be registered.
:param cls: the ClassRegistry instance
:type: ClassRegistry
:param packageDir: the package for which all modules should be imported
:type packageDir: str
'''
......@@ -135,12 +133,13 @@ class ClassRegistry(abc.ABCMeta):
@classmethod
def info(cls, interface):
'''
Returns informations about the subclasses of a given base class stored in the registry.
Returns informations about the subclasses of a given base class stored in the registry.
:param cls: the ClassRegistry instance
:type cls: ClassRegistry
:param interface: the name of base class of whom information about its subclasses is requested
:type interface: str
:return: return the stringified list of subclasses of a given registered interface.
:rtype: str
'''
if not cls._registry.has_key(interface):
......@@ -193,8 +192,8 @@ class ClassRegistry(abc.ABCMeta):
'''
Returns the interfaces that are currently registered.
:param cls: the ClassRegsitry instance
:type cls: ClassRegistry
:return: the interfaces currently registered.
:rtype: list of str
'''
return sorted(cls._registry.keys())
\ No newline at end of file
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: Eric C. Pellegrini
:author: Eric C. Pellegrini
'''
import abc
......@@ -51,7 +51,7 @@ class PreferencesItem(object):
'''
This is the base class for defining a preferences item.
A preferences item implements is a light object used to check preferences before setting them
A preferences item implements is a light object used to check preferences before setting them
but also classify preferences according to their section for a further use in MDANSE GUI.
'''
......@@ -229,7 +229,7 @@ class Preferences(object):
'''
This class implements the MDANSE preferences.
:note: Preferences are defined using the ConfigParser python module that allows to read and write
:note: Preferences are defined using the ConfigParser python module that allows to read and write \
preferences stored in a formatted INI file (RFC822).
'''
......
......@@ -89,7 +89,6 @@ class MasterProcessError(Exception):
pass
class MasterProcess(object):
"""
Master process in a master-slave setup
......@@ -163,9 +162,9 @@ class MasterProcess(object):
pass
def requestTask(self, tag, *parameters):
"""
'''
Launches a task request. The task will be executed by a slave
process in a method called "do_"+tag that is called with the
process in a method called 'do\_'+tag that is called with the
parameters given in the task request. Note that the order of
task executions is not defined.
......@@ -179,7 +178,8 @@ class MasterProcess(object):
:return: a unique task id
:rtype: C{str}
"""
'''
return self.task_manager.addTaskRequest(tag, parameters)
def retrieveResult(self, tag=None):
......@@ -285,15 +285,14 @@ exec slave_code % port in namespace
process.stdin.close()
class SlaveProcess(object):
"""
Slave process in a master-slave setup
A concrete slave process in a program is implemented by subclassing
this class and adding the methods that handle the computational
tasks. Such a method has the name "do_" followed by the tag of the
tasks. Such a method has the name 'do\_' followed by the tag of the
computational task. The process is then launched by calling the
method "start".
method 'start'.
"""
def __init__(self, label, master_host=None, watchdog_period=120.):
......@@ -542,7 +541,7 @@ def initializeMasterProcess(label, slave_script=None, slave_module=None,
:rtype: L{MasterProcess}
"""
import atexit
import os
process = MasterProcess(label, use_name_server)
atexit.register(process.shutdown)
if slave_script is not None or slave_module is not None:
......
......@@ -22,7 +22,7 @@
#
#You should have received a copy of the GNU Lesser General Public
#License along with this library; if not, write to the Free Software
#Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
#Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
'''
Created on Mar 30, 2015
......@@ -56,8 +56,9 @@ def do_run_step(job, step):
return job.run_step(step)
from MDANSE.DistributedComputing.MasterSlave import startSlaveProcess
# Start the slave process
startSlaveProcess(master_host="localhost:%d")
if __name__ == "__builtin__":
from MDANSE.DistributedComputing.MasterSlave import startSlaveProcess
# Start the slave process
startSlaveProcess(master_host="localhost:%d")
......@@ -309,8 +309,9 @@ sys.modules[__name__ + ".moves.urllib.response"] = Module_six_moves_urllib_respo
class Module_six_moves_urllib_robotparser(types.ModuleType):
"""Lazy loading of moved objects in six.moves.urllib_robotparser"""
'''Lazy loading of moved objects in six.moves.urllib_robotparser.
'''
_urllib_robotparser_moved_attributes = [
MovedAttribute("RobotFileParser", "robotparser", "urllib.robotparser"),
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
import collections
......@@ -48,8 +48,8 @@ class Configurable(object):
Within that framework, to be configurable, a class must:
#. derive from this class
#. implement the "configurators" class attribute as a list of 3-tuple whose:
#.. 0-value is the type of the configurator that will be used to fetch the corresponding
MDANSE.Framework.Configurators.IConfigurator.IConfigurator derived class from the configurators registry
#.. 0-value is the type of the configurator that will be used to fetch the corresponding \
MDANSE.Framework.Configurators.IConfigurator.IConfigurator derived class from the configurators registry
#.. 1-value is the name of the configurator that will be used as the key of the _configuration attribute.
#.. 2-value is the dictionary of the keywords used when initializing the configurator.
'''
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: Eric C. Pellegrini
:author: Eric C. Pellegrini
'''
import collections
......@@ -55,9 +55,9 @@ class AtomSelectionConfigurator(IConfigurator):
To Build an atom selection from the GUI you have to:
* Create a workspace based on a MMTK trajectory data
* Drag a molecular viewer on it
* Drag into the Molecular Viewer the Atom selection plugin
#. Create a workspace based on a MMTK trajectory data
#. Drag a molecular viewer on it
#. Drag into the Molecular Viewer the Atom selection plugin
:note: this configurator depends on 'trajectory' and 'grouping_level' configurators to be configured
'''
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: Eric C. Pellegrini
:author: Eric C. Pellegrini
'''
from MDANSE import ELEMENTS
......@@ -48,9 +48,9 @@ class AtomTransmutationConfigurator(IConfigurator):
To Build an atomic transmutation from the GUI you have to :
* Create a workspace based on a MMTK trajectory data,
* Drag a molecular viewer on it,
* Drag into the Molecular Viewer the Atom transmutation plugin
#. Create a workspace based on a MMTK trajectory data,
#. Drag a molecular viewer on it,
#. Drag into the Molecular Viewer the Atom transmutation plugin
:note: this configurator depends on 'trajectory' and 'atom_selection' configurators to be configured
"""
......@@ -65,14 +65,14 @@ class AtomTransmutationConfigurator(IConfigurator):
The value can be:
* None: no transmutation is performed
* (str,str)-dict: for each (str,str) pair, a transmutation will be performed
by parsing the 1st element as an atom selection string and transmutating the
corresponding atom selection to the target chemical element stored in the 2nd element
* str: the transmutation will be performed by reading the corresponding user definition
#. ``None``: no transmutation is performed
#. (str,str)-dict: for each (str,str) pair, a transmutation will be performed by parsing \
the 1st element as an atom selection string and transmutating the corresponding atom \
selection to the target chemical element stored in the 2nd element
#. str: the transmutation will be performed by reading the corresponding user definition
:param configuration: the current configuration
:type configuration: a MDANSE.Framework.Configurable.Configurable object
:type configuration: MDANSE.Framework.Configurable.Configurable
:param value: the input value
:type value: None or (str,str)-dict or str
'''
......@@ -117,11 +117,10 @@ class AtomTransmutationConfigurator(IConfigurator):
Transmutates a set of atoms to a given element
:param configuration: the current configuration
:type configuration: a MDANSE.Framework.Configurable.Configurable object
:type configuration: MDANSE.Framework.Configurable.Configurable
:param selection: the indexes of the atoms to be transmutated
:type selection: list of int
:param element: the symbol of the element to which the selected atoms should
be transmutated
:param element: the symbol of the element to which the selected atoms should be transmutated
:type element: str
'''
......
......@@ -27,10 +27,10 @@
'''
Created on Mar 30, 2015
@author: Eric C. Pellegrini and Bachir Aoun
:author: Bachir Aoun and Eric C. Pellegrini
'''
from MDANSE.Framework.UserDefinitionsStore import UD_STORE, UserDefinitionsStoreError
from MDANSE.Framework.UserDefinitionsStore import UD_STORE
from MDANSE.Framework.Configurators.IConfigurator import IConfigurator
from MDANSE.MolecularDynamics.Trajectory import find_atoms_in_molecule
......@@ -42,11 +42,11 @@ class AxisSelection(IConfigurator):
To Build an axis selection from the GUI you have to :
* Create a workspace based on a mmtk_trajectory data,
* Drag a molecular viewer on it,
* Drag into the Molecular Viewer the Axis selection plugin
#. Create a workspace based on a mmtk_trajectory data,
#. Drag a molecular viewer on it,
#. Drag into the Molecular Viewer the Axis selection plugin
:note: this configurator depends on 'trajectory' configurator to be configured
:note: this configurator depends on 'trajectory' configurator to be configured.
"""
type = "axis_selection"
......@@ -59,14 +59,13 @@ class AxisSelection(IConfigurator):
The value can be:
* a dict with 'molecule', 'endpoint1' and 'endpoint2' keys. 'molecule' key
is the molecule name for which the axis selection will be performed
and 'endpoint1' and 'endpoint2' keys are the names of two atoms of the molecule
along which the axis will be defined
* str: the axis selection will be performed by reading the corresponding user definition
#. a dict with *'molecule'*, *'endpoint1'* and *'endpoint2'* keys. *'molecule'* key \
is the name of the molecule for which the axis selection will be performed and *'endpoint1'* \
and *'endpoint2'* keys are the names of two atoms of the molecule along which the axis will be defined
#. str: the axis selection will be performed by reading the corresponding user definition.
:param configuration: the current configuration
:type configuration: a MDANSE.Framework.Configurable.Configurable object
:type configuration: MDANSE.Framework.Configurable.Configurable
:param value: the input value
:type value: tuple or str
'''
......
......@@ -27,10 +27,10 @@
'''
Created on Mar 30, 2015
@author: Eric C. Pellegrini and Bachir Aoun
@author: Bachir Aoun and Eric C. Pellegrini
'''
from MDANSE.Framework.UserDefinitionsStore import UD_STORE, UserDefinitionsStoreError
from MDANSE.Framework.UserDefinitionsStore import UD_STORE
from MDANSE.Framework.Configurators.IConfigurator import IConfigurator
from MDANSE.MolecularDynamics.Trajectory import find_atoms_in_molecule
......@@ -44,9 +44,9 @@ class BasisSelection(IConfigurator):
To Build a basis selection from the GUI you have to :
* Create a workspace based on a mmtk_trajectory data,
* Drag a molecular viewer on it,
* Drag into the Molecular Viewer the Basis selection plugin
#. Create a workspace based on a mmtk_trajectory data,
#. Drag a molecular viewer on it,
#. Drag into the Molecular Viewer the Basis selection plugin
"""
type = 'basis_selection'
......@@ -59,14 +59,13 @@ class BasisSelection(IConfigurator):
The value can be:
* a dict with 'molecule', 'origin', 'x_axis' and 'y_axis' keys.
'molecule' key is the molecule name for which the axis selection will be performed
and 'origin', 'x_axis' and 'y_axis' keys are the names of three atoms of the molecule
that will be used to define respectively the origin, the X and Y axis of the basis
* str: the axis selection will be performed by reading the corresponding user definition
#. a dict with *'molecule'*, *'origin'*, *'x_axis'* and *'y_axis'* keys. *'molecule'* key is \
the name of the molecule for which the axis selection will be performed and *'origin'*, *'x_axis'* and *'y_axis'* \
keys are the names of three atoms of the molecule that will be used to define respectively the origin, the X and Y axis of the basis
#. str: the axis selection will be performed by reading the corresponding user definition.
:param configuration: the current configuration
:type configuration: a MDANSE.Framework.Configurable.Configurable object
:type configuration: MDANSE.Framework.Configurable.Configurable
:param value: the input value
:type value: tuple or str
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: Eric C. Pellegrini
:author: Eric C. Pellegrini
'''
from MDANSE.Framework.Configurators.RangeConfigurator import RangeConfigurator
......@@ -38,10 +38,10 @@ class FramesConfigurator(RangeConfigurator):
The frame selection can be input as:
* a 3-tuple where the 1st, 2nd will corresponds respectively to the indexes of the first and last (excluded) frames to be selected while the 3rd element
will correspond to the step number between two frames. For example (1,11,3) will give 1,4,7,10
* 'all' keyword, in such case, all the frames of the trajectory are selected
* None keyword, in such case, all the frames of the trajectory are selected
#. a 3-tuple where the 1st, 2nd will corresponds respectively to the indexes of the first and \
last (excluded) frames to be selected while the 3rd element will correspond to the step number between two frames. For example (1,11,3) will give 1,4,7,10
#. *'all'* keyword, in such case, all the frames of the trajectory are selected
#. ``None`` keyword, in such case, all the frames of the trajectory are selected
:note: this configurator depends on 'trajectory' configurator to be configured
"""
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: Eric C. Pellegrini
:author: Eric C. Pellegrini
'''
import abc
......@@ -103,9 +103,9 @@ class IConfigurator(dict):
:param name: the name of this configurator.
:type name: str
:param dependencies: the other configurators on which this configurator depends on to be configured. This has to be input as a
dictionary that maps the name under which the dependency will be used within the configurator implementation to the actual name
of the configurator on which this configurator is depending on.
:param dependencies: the other configurators on which this configurator depends on to be configured. \
This has to be input as a dictionary that maps the name under which the dependency will be used within \
the configurator implementation to the actual name of the configurator on which this configurator is depending on.
:type dependencies: (str,str)-dict
:param default: the default value of this configurator.
:type default: any python object
......@@ -185,8 +185,8 @@ class IConfigurator(dict):
'''
Configures this configurator with a given value.
:param configuration: the current configuration. The configuration is passed at configuration time because it can be used in the case where
the configurator depends on other configurators to be comfigured.
:param configuration: the current configuration. The configuration is passed at configuration time \
because it can be used in the case where the configurator depends on other configurators to be comfigured.
:type configuration: Framework.Configurable.Configurable object
:param value: the input value to be configured.
:type value: depends on the configurator
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: Eric C. Pellegrini
:author: Eric C. Pellegrini
'''
import numpy
......@@ -47,7 +47,7 @@ class InstrumentResolutionConfigurator(IConfigurator):
inverse-fourier-transformed to get a time-dependant version. This time-dependant resolution function will then
be multiplied by the time-dependant signal to get the resolution effect according to the Fourier Transform theorem:
.. math:: TF(f(t) * r(t)) = F(\omega) \conv R(\omega) = G(\omega)
.. math:: TF(f(t) * r(t)) = F(\omega) \otimes R(\omega) = G(\omega)
where f(t) and r(t) are respectively the time-dependant signal and instrument resolution and
F(\omega) and R(\omega) are their corresponding spectrum. Hence, G(\omega) represents the signal
......@@ -57,7 +57,7 @@ class InstrumentResolutionConfigurator(IConfigurator):
An instrument resolution is represented in MDANSE by a kernel function and a sets of parameters for this function.
MDANSE currently supports the aussian, lorentzian, square, triangular and pseudo-voigt kernels.
:note: this configurator depends on the 'frame' configurator to be configured
:note: this configurator depends on the 'frame' configurator to be configured.
"""
......@@ -70,10 +70,10 @@ class InstrumentResolutionConfigurator(IConfigurator):
Configure the instrument resolution.
:param configuration: the current configuration
:type configuration: a MDANSE.Framework.Configurable.Configurable object
:param value: the instrument resolution. It must be input as a 2-tuple where the 1st element is the instrument resolution
kernel and the 2nd element is a dictionary that stores the parameters for this kernel.
is a string representing one of the supported instrument resolution
:type configuration: subclass of :class: MDANSE.Framework.Configurable.Configurable
:param value: the instrument resolution. It must a 2-tuple where the 1st element is the \
is a string representing one of the supported instrument resolution and the 2nd element \
is a dictionary that stores the parameters for this kernel.
:type value: 2-tuple
'''
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: Eric C. Pellegrini
:author: Eric C. Pellegrini
'''
from MDANSE.Framework.Configurators.IConfigurator import ConfiguratorError
......@@ -35,15 +35,13 @@ from MDANSE.Framework.Configurators.SingleChoiceConfigurator import SingleChoice
class InterpolationOrderConfigurator(SingleChoiceConfigurator):
"""
This configurator allows to input the interpolation order to be applied when deriving velocities
from atomic coordinates.
This configurator allows to input the interpolation order to be applied when deriving velocities from atomic coordinates.
The allowed value are 'no interpolation','1st order','2nd order','3rd order','4th order' or '5th order', the former
one will not interpolate the velocities from atomic coordinates but will directly use the velocities stored in the
trajectory file.
The allowed value are *'no interpolation'*,*'1st order'*,*'2nd order'*,*'3rd order'*,*'4th order'* or *'5th order'*, the
former one will not interpolate the velocities from atomic coordinates but will directly use the velocities stored in the trajectory file.
:attention: it is of paramount importance for the trajectory to be sampled with a very low time step to get accurate
velocities interpolated from atomic coordinates.
:attention: it is of paramount importance for the trajectory to be sampled with a very low time \
step to get accurate velocities interpolated from atomic coordinates.
:note: this configurator depends on 'trajectory' configurator to be configured.
"""
......@@ -69,9 +67,9 @@ class InterpolationOrderConfigurator(SingleChoiceConfigurator):
Configure the input interpolation order.
:param configuration: the current configuration.
:type configuration: a MDANSE.Framework.Configurable.Configurable object.
:type configuration: MDANSE.Framework.Configurable.Configurable
:param value: the interpolation order to be configured.
:type value: str one of 'no interpolation','1st order','2nd order','3rd order','4th order' or '5th order'.
:type value: str one of *'no interpolation'*,*'1st order'*,*'2nd order'*,*'3rd order'*,*'4th order'* or *'5th order'*.
'''
SingleChoiceConfigurator.configure(self, configuration, value)
......
......@@ -27,7 +27,7 @@
'''
Created on May 21, 2015
@author: Eric C. Pellegrini
:author: Eric C. Pellegrini
'''
import os
......@@ -71,8 +71,8 @@ class OutputFilesConfigurator(IConfigurator):
:param configuration: the current configuration.
:type configuration: a MDANSE.Framework.Configurable.Configurable object
:param value: the output files specifications. Must be a 3-tuple whose 1st element if the output directory, 2nd element the basename and 3rd element
a list of file formats.
:param value: the output files specifications. Must be a 3-tuple whose 1st element \
if the output directory, 2nd element the basename and 3rd element a list of file formats.
:type value: 3-tuple
'''
......
......@@ -27,7 +27,7 @@
'''
Created on May 21, 2015
@author: Eric C. Pellegrini
:author: Eric C. Pellegrini
'''
......@@ -52,9 +52,10 @@ class ProjectionConfigurator(IConfigurator):
:param configuration: the current configuration.
:type configuration: a MDANSE.Framework.Configurable.Configurable object
:param value: the input projector definition. It can be a 2-tuple whose 1st element if the name of the projector (one of 'null','axial' or 'planar')
and the 2nd element the parameters for the selected projector (None for 'null', a Scientific.Vector for 'axial' and a list of two Scientific.Vector for
'planar') or None in the case where no projection is needed.
:param value: the input projector definition. It can be a 2-tuple whose 1st element if the name \
of the projector (one of *'null'*,*'axial'* or *'planar'*) and the 2nd element the parameters for the selected \
projector (None for *'null'*, a Scientific.Vector for *'axial'* and a list of two Scientific.Vector for *'planar'*) \
or ``None`` in the case where no projection is needed.
:type value: 2-tuple
'''
......
......@@ -27,7 +27,7 @@
'''
Created on May 22, 2015
@author: Eric C. Pellegrini
:author: Eric C. Pellegrini
'''
from MDANSE import REGISTRY
......@@ -50,7 +50,7 @@ class QVectorsConfigurator(IConfigurator):
To define a new Q vectors generator, you must inherit from MDANSE.Framework.QVectors.QVectors.QVector interface.