Commit f7413cd4 authored by BO ZHANG's avatar BO ZHANG 🏀
Browse files

updated tutorial for CsstMscData

parent 8be103c9
...@@ -53,4 +53,6 @@ html_theme = 'sphinx_rtd_theme' ...@@ -53,4 +53,6 @@ html_theme = 'sphinx_rtd_theme'
# Add any paths that contain custom static files (such as style sheets) here, # 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, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static'] html_static_path = ['_static']
\ No newline at end of file
pygments_style = "sphinx"
\ No newline at end of file
...@@ -3,13 +3,14 @@ ...@@ -3,13 +3,14 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
Welcome to csst's documentation! Work with `csst`
================================ ======================
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 1
:caption: Contents:
tutorial
Indices and tables Indices and tables
......
How to use CsstMscData
======================
*CsstMscData* is inherited from *CsstData*.
Example:
.. code-block:: python
:linenos:
# set file path
fp = "MSC_CLB_210525120000_100000000_06_raw.fits"
# import CsstMscImgData
from csst.msc import CsstMscImgData
# read data
data = CsstMscImgData.read(fp)
To show the info of data:
.. code-block:: python
:linenos:
# print info
print("data: ", data)
print("instrument: ", data.get_l0keyword("pri", "INSTRUME"))
print("object: ", data.get_l0keyword("pri", "OBJECT"))
The output:
.. code-block::
:linenos:
data: <CsstMscImgData: MSC CCD16>
instrument: MSC
object: 100000279
to be updated ...
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