sphinx/source/dm.ds_web_service.api.rst

-.. automodule:: dm.ds_web_service.api
-
-.. currentmodule:: dm.ds_web_service.api
-
-DsApiFactory
--------------
-
-.. autoclass:: dm.ds_web_service.api.dsApiFactory.DsApiFactory()
-    :show-inheritance:
-    :members: getUserDsApi, getAuthDsApi, getExperimentDsApi, getFileDsApi, getEsafDsApi, getServiceMonitorDsApi
-
-AuthDsApi
----------
-
-.. autoclass:: dm.ds_web_service.api.authDsApi.AuthDsApi()
-    :show-inheritance: 
-    :members:  __init__, addSession, checkSession, getAuthorizationPrincipal
-
-EsafDsApi
----------
-
-.. autoclass:: dm.ds_web_service.api.esafDsApi.EsafDsApi()
-    :show-inheritance: 
-    :members:  __init__, getSectorEsafsByYear, getEsafById
-
-FileDsApi
----------
-
-.. autoclass:: dm.ds_web_service.api.fileDsApi.FileDsApi()
-    :show-inheritance: 
-    :members:  __init__, processFile, compressFile, decompressFile, deleteFile, statFile, processDirectory, download
-
-ExperimentDsApi
----------------
-
-.. autoclass:: dm.ds_web_service.api.experimentDsApi.ExperimentDsApi()
-    :show-inheritance: 
-    :members:  __init__, getExperimentTypes, getExperiments, getExperimentsByStation, getExperimentByName, getExperimentById, addExperiment, updateExperiment, deleteExperimentById, deleteExperimentByName
-
-ServiceMonitorDsApi
---------------------
-
-.. autoclass:: dm.ds_web_service.api.serviceMonitorDsApi.ServiceMonitorDsApi()
-    :show-inheritance:
-    :members:  __init__, getServiceStatus, clearServiceStatus
-
-UserDsApi
----------
-
-.. autoclass:: dm.ds_web_service.api.userDsApi.UserDsApi()
-    :show-inheritance: 
-    :members:  __init__, getUsers, getUserById, getUserByUsername, addUserSystemRole, deleteUserSystemRole, addUserExperimentRole, deleteUserExperimentRole
-
-

sphinx/source/dm.proc_web_service.api.rst

-.. automodule:: dm.proc_web_service.api
-
-.. currentmodule:: dm.proc_web_service.api
-
-ProcApiFactory
---------------
-
-.. autoclass:: dm.proc_web_service.api.procApiFactory.ProcApiFactory()
-    :show-inheritance: 
-    :members: getServiceMonitorProcApi, getWorkflowProcApi 
-
-ServiceMonitorProcApi
----------------------
-
-.. autoclass:: dm.proc_web_service.api.serviceMonitorProcApi.ServiceMonitorProcApi()
-    :show-inheritance: 
-    :members:  __init__, getServiceStatus, clearServiceStatus
-
-WorkflowProcApi
----------------
-
-.. autoclass:: dm.proc_web_service.api.workflowProcApi.WorkflowProcApi()
-    :show-inheritance: 
-    :members:  __init__, listWorkflows, addWorkflow, getWorkflowById, getWorkflowByName, updateWorkflow, deleteWorkflowByName, listProcessingJobs, startProcessingJob, getProcessingJobById
-

sphinx/source/index.rst

-.. APS Data Management documentation master file, created by
-   sphinx-quickstart on Thu Feb 23 09:20:39 2017.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-Welcome to APS Data Management's documentation!
-===============================================
-
-The `dm` package contains python APIs for accessing Data Management services.
-
-.. toctree::
-   :maxdepth: 4
-   :caption: Contents:
-
-   dm.common.api
-   dm.aps_db_web_service.api
-   dm.cat_web_service.api
-   dm.daq_web_service.api
-   dm.ds_web_service.api
-   dm.proc_web_service.api
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`

station_gui_features.txt

-* login screen
-  - should not appear if user has $DM_LOGIN_FILE set, and login is valid
-
-* list of experiments screen
-  - view/modify details of an experiment
-  - button for adding new experiment
-
-* view/modify experiment screen
-  - display list of users associated with experiment
-  - display ongoing DAQs/uploads
-  - start new DAQ/upload
-  - add users, either manually or associated with a given proposal
-  - remove users 
-
-* add new experiment dialog
-  - add users, either manually or associated with a given proposal
-  - start DAQ/upload immediately
-
-* list of DAQs screen
-  - view DAQ details
-  - start new DAQ
-  - stop DAQ
-
-* list of uploads screen
-  - view details
-  - start new 
-  - cancel running upload