updated tutorial for CsstMscData (f7413cd4) · Commits · Bo Zhang / csst

doc/source/conf.py

+3 −1

Original line number	Original line	Diff line number	Diff line
	@@ -54,3 +54,5 @@ html_theme = 'sphinx_rtd_theme'
	# 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']

			pygments_style = "sphinx"
			No newline at end of file

+5 −4

Original line number	Original line	Diff line number	Diff line
	@@ -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

0 → 100644

+37 −0

Original line number	Original line	Diff line number	Diff line
			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 ...