Skip to content
GitLab
Commit dab23158 authored by Wei Shoulin's avatar Wei Shoulin
Browse files

status-1

parent 8a234fe9
Hide whitespace changes
Inline Side-by-side
csst_dfs_api/facility/calmerge.py
View file @ dab23158
......@@ -12,7 +12,7 @@ class CalMergeApi(object):
def find(self, **kwargs):
''' retrieve calibration merge records from database
parameter kwargs:
Args:
detector_no: [str]
ref_type: [str]
obs_time: (start,end)
......@@ -20,48 +20,46 @@ class CalMergeApi(object):
prc_status : [int]
file_name: [str]
limit: limits returns the number of records,default 0:no-limit
return: csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.find(**kwargs)
def get(self, **kwargs):
''' fetch a record from database
parameter kwargs:
Args:
id : [int]
return csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.get(**kwargs)
def update_proc_status(self, **kwargs):
''' update the status of reduction
parameter kwargs:
Args:
id : [int],
status : [int]
return csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.update_proc_status(**kwargs)
def update_qc1_status(self, **kwargs):
''' update the status of reduction
parameter kwargs:
AArgs:
id : [int],
status : [int]
return csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.update_qc1_status(**kwargs)
def write(self, **kwargs):
''' insert a calibration merge record into database
parameter kwargs:
id : [int]
Args:
detector_no : [str]
ref_type : [str]
obs_time : [str]
......@@ -71,7 +69,8 @@ class CalMergeApi(object):
filename : [str]
file_path : [str]
level0_ids : [list]
return csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.write(**kwargs)
csst_dfs_api/facility/detector.py
View file @ dab23158
......@@ -11,88 +11,90 @@ class DetectorApi(object):
def find(self, **kwargs):
''' retrieve detector records from database
parameter kwargs:
Args:
module_id: [str]
key: [str]
return: csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.find(**kwargs)
def get(self, **kwargs):
''' fetch a record from database
parameter kwargs:
Args:
no : [str]
return csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.get(**kwargs)
def update(self, **kwargs):
''' update a detector by no
parameter kwargs:
Args:
no : [str],
detector_name : [str],
module_id : [str],
filter_id : [str]
return csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.update(**kwargs)
def delete(self, **kwargs):
''' delete a detector by no
parameter kwargs:
Args:
no : [str]
return csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.delete(**kwargs)
def write(self, **kwargs):
''' insert a detector record into database
parameter kwargs:
Args:
no : [str],
detector_name : [str],
module_id : [str],
filter_id : [str]
return csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.write(**kwargs)
def find_status(self, **kwargs):
''' retrieve a detector status's from database
parameter kwargs:
Args:
detector_no: [str]
status_occur_time: (begin,end)
limit: limits returns the number of records,default 0:no-limit
return: csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.find_status(**kwargs)
def get_status(self, **kwargs):
''' fetch a record from database
parameter kwargs:
Args:
id : [int]
return csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.get_status(**kwargs)
def write_status(self, **kwargs):
''' insert a detector status into database
parameter kwargs:
Args:
detector_no : [str],
status : [str],
status_time : [str]
return csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.write_status(**kwargs)
\ No newline at end of file
csst_dfs_api/facility/level0.py
View file @ dab23158
......@@ -12,7 +12,7 @@ class Level0DataApi(object):
def find(self, **kwargs):
''' retrieve level0 records from database
parameter kwargs:
Args:
obs_id: [int]
detector_no: [str]
obs_type: [str]
......@@ -21,43 +21,47 @@ class Level0DataApi(object):
prc_status : [int],
file_name: [str]
limit: limits returns the number of records,default 0:no-limit
return: csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.find(**kwargs)
def get(self, **kwargs):
''' fetch a record from database
parameter kwargs:
Args:
fits_id : [int]
return csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.get(**kwargs)
def update_proc_status(self, **kwargs):
''' update the status of reduction
parameter kwargs:
Args:
fits_id : [int],
status : [int]
Returns:
csst_dfs_common.models.Result
'''
return self.stub.update_proc_status(**kwargs)
def update_qc0_status(self, **kwargs):
''' update the status of QC0
parameter kwargs:
Args:
fits_id : [int],
status : [int]
Returns:
csst_dfs_common.models.Result
'''
return self.stub.update_qc0_status(**kwargs)
def write(self, **kwargs):
''' insert a level0 data record into database
parameter kwargs:
Args:
obs_id = [int]
detector_no = [str]
obs_type = [str]
......@@ -66,7 +70,8 @@ class Level0DataApi(object):
detector_status_id = [int]
filename = [str]
file_path = [str]
return: csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.write(**kwargs)
csst_dfs_api/facility/level0prc.py
View file @ dab23158
......@@ -12,31 +12,31 @@ class Level0PrcApi(object):
def find(self, **kwargs):
''' retrieve level0 procedure records from database
parameter kwargs:
Args:
level0_id: [int]
pipeline_id: [str]
prc_module: [str]
prc_status : [int]
return: csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.find(**kwargs)
def update_proc_status(self, **kwargs):
''' update the status of reduction
parameter kwargs:
Args:
id : [int],
status : [int]
return csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.update_proc_status(**kwargs)
def write(self, **kwargs):
''' insert a level0 procedure record into database
parameter kwargs:
Args:
level0_id : [int]
pipeline_id : [str]
prc_module : [str]
......@@ -44,7 +44,8 @@ class Level0PrcApi(object):
prc_status : [int]
prc_time : [str]
file_path : [str]
return csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.write(**kwargs)
csst_dfs_api/facility/observation.py
View file @ dab23158
......@@ -12,26 +12,25 @@ class ObservationApi(object):
def find(self, **kwargs):
''' retrieve exposure records from database
parameter kwargs:
obs_id = [int]
Args:
module_id: [str]
obs_type: [str]
obs_time : (start, end),
qc0_status : [int],
prc_status : [int],
limit: limits returns the number of records,default 0:no-limit
return: csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.find(**kwargs)
def get(self, **kwargs):
''' fetch a record from database
parameter kwargs:
Args:
obs_id = [int]
return: csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.get(**kwargs)
......@@ -39,37 +38,38 @@ class ObservationApi(object):
def update_proc_status(self, **kwargs):
''' update the status of reduction
parameter kwargs:
Args:
obs_id = [int],
status = [int]
return: csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.update_proc_status(**kwargs)
def update_qc0_status(self, **kwargs):
''' update the status of QC0
parameter kwargs:
Args:
obs_id = [int],
status = [int]
return: csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.update_qc0_status(**kwargs)
def write(self, **kwargs):
''' insert a observational record into database
parameter kwargs:
Args:
obs_id = [int]
obs_time = [str]
exp_time = [float]
module_id = [str]
obs_type = [str]
facility_status_id = [int]
module_status_id = [int]
return: csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.write(**kwargs)
csst_dfs_api/ifs/level1.py
View file @ dab23158
......@@ -12,7 +12,7 @@ class Level1DataApi(object):
def find(self, **kwargs):
''' retrieve level1 records from database
parameter kwargs:
Args:
raw_id: [int]
data_type: [str]
obs_type: [str]
......@@ -21,18 +21,18 @@ class Level1DataApi(object):
prc_status : [int],
filename: [str]
limit: limits returns the number of records,default 0:no-limit
return: csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.find(**kwargs)
def get(self, **kwargs):
''' fetch a record from database
parameter kwargs:
Args:
id : [int]
return csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.get(**kwargs)
......@@ -40,29 +40,29 @@ class Level1DataApi(object):
def update_proc_status(self, **kwargs):
''' update the status of reduction
parameter kwargs:
Args:
id = [int],
status = [int]
return: csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.update_proc_status(**kwargs)
def update_qc1_status(self, **kwargs):
''' update the status of QC0
parameter kwargs:
Args:
id = [int],
status = [int]
return: csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.update_qc1_status(**kwargs)
def write(self, **kwargs):
''' insert a level1 record into database
parameter kwargs:
Args:
raw_id : [int]
data_type : [str]
cor_sci_id : [int]
......@@ -78,8 +78,8 @@ class Level1DataApi(object):
prc_status : [int]
prc_time : [str]
pipeline_id : [str]
return csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.write(**kwargs)
csst_dfs_api/msc/level1.py
View file @ dab23158
......@@ -12,7 +12,7 @@ class Level1DataApi(object):
def find(self, **kwargs):
''' retrieve level1 records from database
parameter kwargs:
Args:
raw_id: [int]
data_type: [str]
obs_type: [str]
......@@ -21,18 +21,18 @@ class Level1DataApi(object):
prc_status : [int],
filename: [str]
limit: limits returns the number of records,default 0:no-limit
return: csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.find(**kwargs)
def get(self, **kwargs):
''' fetch a record from database
parameter kwargs:
Args:
id : [int]
return csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.get(**kwargs)
......@@ -40,29 +40,29 @@ class Level1DataApi(object):
def update_proc_status(self, **kwargs):
''' update the status of reduction
parameter kwargs:
Args:
id = [int],
status = [int]
return: csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.update_proc_status(**kwargs)
def update_qc1_status(self, **kwargs):
''' update the status of QC0
parameter kwargs:
Args:
id = [int],
status = [int]
return: csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.update_qc1_status(**kwargs)
def write(self, **kwargs):
''' insert a level1 record into database
parameter kwargs:
Args:
raw_id : [int]
data_type : [str]
cor_sci_id : [int]
......@@ -75,8 +75,8 @@ class Level1DataApi(object):
prc_status : [int]
prc_time : [str]
pipeline_id : [str]
return csst_dfs_common.models.Result
Returns:
csst_dfs_common.models.Result
'''
return self.stub.write(**kwargs)
docs/Makefile 0 → 100644
View file @ dab23158
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SOURCEDIR = source
BUILDDIR = build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
\ No newline at end of file
docs/rst/csst_dfs_api.common.rst 0 → 100644
View file @ dab23158
csst\_dfs\_api.common package
=============================
Submodules
----------
csst\_dfs\_api.common.catalog module
------------------------------------
.. automodule:: csst_dfs_api.common.catalog
:members:
:undoc-members:
:show-inheritance:
csst\_dfs\_api.common.constants module
--------------------------------------
.. automodule:: csst_dfs_api.common.constants
:members:
:undoc-members:
:show-inheritance:
csst\_dfs\_api.common.delegate module
-------------------------------------
.. automodule:: csst_dfs_api.common.delegate
:members:
:undoc-members:
:show-inheritance:
csst\_dfs\_api.common.utils module
----------------------------------
.. automodule:: csst_dfs_api.common.utils
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: csst_dfs_api.common
:members:
:undoc-members:
:show-inheritance:
docs/rst/csst_dfs_api.cpic.rst 0 → 100644
View file @ dab23158
csst\_dfs\_api.cpic package
===========================
Module contents
---------------
.. automodule:: csst_dfs_api.cpic
:members:
:undoc-members:
:show-inheritance:
docs/rst/csst_dfs_api.facility.rst 0 → 100644
View file @ dab23158
csst\_dfs\_api.facility package
===============================
Submodules
----------
csst\_dfs\_api.facility.calmerge module
---------------------------------------
.. automodule:: csst_dfs_api.facility.calmerge
:members:
:undoc-members:
:show-inheritance:
csst\_dfs\_api.facility.detector module
---------------------------------------
.. automodule:: csst_dfs_api.facility.detector
:members:
:undoc-members:
:show-inheritance:
csst\_dfs\_api.facility.level0 module
-------------------------------------
.. automodule:: csst_dfs_api.facility.level0
:members:
:undoc-members:
:show-inheritance:
csst\_dfs\_api.facility.level0prc module
----------------------------------------
.. automodule:: csst_dfs_api.facility.level0prc
:members:
:undoc-members:
:show-inheritance:
csst\_dfs\_api.facility.observation module
------------------------------------------
.. automodule:: csst_dfs_api.facility.observation
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: csst_dfs_api.facility
:members:
:undoc-members:
:show-inheritance:
docs/rst/csst_dfs_api.hstdm.rst 0 → 100644
View file @ dab23158
csst\_dfs\_api.hstdm package
============================
Module contents
---------------
.. automodule:: csst_dfs_api.hstdm
:members:
:undoc-members:
:show-inheritance:
docs/rst/csst_dfs_api.ifs.rst 0 → 100644
View file @ dab23158
csst\_dfs\_api.ifs package
==========================
Submodules
----------
csst\_dfs\_api.ifs.level1 module
--------------------------------
.. automodule:: csst_dfs_api.ifs.level1
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: csst_dfs_api.ifs
:members:
:undoc-members:
:show-inheritance:
docs/rst/csst_dfs_api.mci.rst 0 → 100644
View file @ dab23158
csst\_dfs\_api.mci package
==========================
Module contents
---------------
.. automodule:: csst_dfs_api.mci
:members:
:undoc-members:
:show-inheritance:
docs/rst/csst_dfs_api.msc.rst 0 → 100644
View file @ dab23158
csst\_dfs\_api.msc package
==========================
Submodules
----------
csst\_dfs\_api.msc.level1 module
--------------------------------
.. automodule:: csst_dfs_api.msc.level1
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: csst_dfs_api.msc
:members:
:undoc-members:
:show-inheritance:
docs/rst/csst_dfs_api.rst 0 → 100644
View file @ dab23158
csst\_dfs\_api package
======================
Subpackages
-----------
.. toctree::
:maxdepth: 4
csst_dfs_api.common
csst_dfs_api.cpic
csst_dfs_api.facility
csst_dfs_api.hstdm
csst_dfs_api.ifs
csst_dfs_api.mci
csst_dfs_api.msc
Module contents
---------------
.. automodule:: csst_dfs_api
:members:
:undoc-members:
:show-inheritance:
docs/rst/modules.rst 0 → 100644
View file @ dab23158
csst_dfs_api
============
.. toctree::
:maxdepth: 4
csst_dfs_api
docs/source/conf.py 0 → 100644
View file @ dab23158
# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/master/config
# -- Path setup --------------------------------------------------------------
# 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.
#
import os
import sys
sys.path.insert(0, os.path.abspath('../..'))
# -- Project information -----------------------------------------------------
project = 'CSST DFS API'
copyright = '2021, CSST DFS Team'
author = 'CSST DFS Team'
# The short X.Y version
version = ''
# The full version, including alpha/beta/rc tags
release = '0.0.1'
# -- 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.intersphinx',
'sphinx.ext.mathjax',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
'sphinx.ext.githubpages',
'rinoh.frontend.sphinx',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = None
# -- 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 = 'alabaster'
# 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 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']
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself. Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# html_sidebars = {}
# -- Options for HTMLHelp output ---------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'CSSTDFSAPIdoc'
# -- 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': '',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'CSSTDFSAPI.tex', 'CSST DFS API Documentation',
'CSST DFS Team', 'manual'),
]
# -- Options for manual page output ------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'csstdfsapi', 'CSST DFS API Documentation',
[author], 1)
]
# -- 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 = [
(master_doc, 'CSSTDFSAPI', 'CSST DFS API Documentation',
author, 'CSSTDFSAPI', 'One line description of project.',
'Miscellaneous'),
]
# -- Options for Epub output -------------------------------------------------
# Bibliographic Dublin Core info.
epub_title = project
# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#
# epub_identifier = ''
# A unique identification for the text.
#
# epub_uid = ''
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
# -- Extension configuration -------------------------------------------------
# -- Options for intersphinx extension ---------------------------------------
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}
\ No newline at end of file
docs/source/index.rst 0 → 100644
View file @ dab23158
.. CSST DFS API documentation master file, created by
sphinx-quickstart on Thu Jun 10 08:55:39 2021.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to CSST DFS API's documentation!
========================================
This package provides APIs to access CSST's files and databases.
Installation
================
This library can be installed with the following command:
.. code-block:: c
git clone https://github.com/astronomical-data-processing/csst-dfs-api.git
cd csst-dfs-api
pip install -r requirements.txt
python setup.py install
* NOTE: This library is heavily under coding, if any bugs occur, firstly you should try to update codes and install again like:
.. code-block:: c
git pull
pip install -r requirements.txt
python setup.py install
Documentation for the Code
**************************
.. toctree::
:maxdepth: 2
:caption: Contents:
Common
=====================
.. automodule:: csst_dfs_api.common
:members:
Facility
=======================
.. automodule:: csst_dfs_api.facility
:members:
MSC
=======================
.. automodule:: csst_dfs_api.msc
:members:
IFS
=======================
.. automodule:: csst_dfs_api.ifs
:members:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
examples/ifs_rss_pipeline.py
View file @ dab23158
......@@ -23,7 +23,7 @@ class RSS(object):
try:
self.raw = self.fitsApi.find(file_name=file_name)
if self.raw.success():
if self.raw.success:
self.raw = self.raw.data()[0] if len(self.raw.data())>0 else None
if self.raw is None:
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment