diff --git a/csst_dfs_api/mbi/level2.py b/csst_dfs_api/mbi/level2.py index af4586ed15c23a90f01c5c994d5ba7c7a309b7e5..a114425e2d9d68b546d29651aa7ef640f4c6ed99 100644 --- a/csst_dfs_api/mbi/level2.py +++ b/csst_dfs_api/mbi/level2.py @@ -55,6 +55,7 @@ class Level2DataApi(object): dec: [float] in deg radius: [float] in deg obs_time: (start, end) + limit: limits returns the number of records,default 0:no-limit :returns: csst_dfs_common.models.Result ''' diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000000000000000000000000000000000000..4c02cd14acdce3b69945d26500c5ff59da4d9776 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,14 @@ +## Build + +```bash +make rst +make html +``` + +## Online Browse + +```bash +pip install sphinx-autobuild +cd docs +sphinx-autobuild source build/html +``` diff --git a/docs/source/rst/csst_dfs_api.facility.rst b/docs/source/rst/csst_dfs_api.facility.rst index 84cb3978a0b713ce4e361614f5a984fa16ec0ed3..33ba7c7e22f6b72057f9e2590975756efe89fe37 100644 --- a/docs/source/rst/csst_dfs_api.facility.rst +++ b/docs/source/rst/csst_dfs_api.facility.rst @@ -20,6 +20,38 @@ csst\_dfs\_api.facility.detector module :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.level1 module +------------------------------------- + +.. automodule:: csst_dfs_api.facility.level1 + :members: + :undoc-members: + :show-inheritance: + +csst\_dfs\_api.facility.level1prc module +---------------------------------------- + +.. automodule:: csst_dfs_api.facility.level1prc + :members: + :undoc-members: + :show-inheritance: + csst\_dfs\_api.facility.level2producer module --------------------------------------------- diff --git a/docs/source/rst/csst_dfs_api.functional.rst b/docs/source/rst/csst_dfs_api.functional.rst new file mode 100644 index 0000000000000000000000000000000000000000..55afdbb59192c373711fcfce33b131134693f2a6 --- /dev/null +++ b/docs/source/rst/csst_dfs_api.functional.rst @@ -0,0 +1,10 @@ +csst\_dfs\_api.functional package +================================= + +Module contents +--------------- + +.. automodule:: csst_dfs_api.functional + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/rst/csst_dfs_api.ifs.rst b/docs/source/rst/csst_dfs_api.ifs.rst index 2826e488d2669260c01419dce1a855b5b8176ca4..b6dd330d918b1d09534928c0533a48d3a5c48dc4 100644 --- a/docs/source/rst/csst_dfs_api.ifs.rst +++ b/docs/source/rst/csst_dfs_api.ifs.rst @@ -1,49 +1,6 @@ csst\_dfs\_api.ifs package ========================== -Submodules ----------- - -csst\_dfs\_api.ifs.calmerge module ----------------------------------- - -.. automodule:: csst_dfs_api.ifs.calmerge - :members: - :undoc-members: - :show-inheritance: - -csst\_dfs\_api.ifs.level0 module --------------------------------- - -.. automodule:: csst_dfs_api.ifs.level0 - :members: - :undoc-members: - :show-inheritance: - -csst\_dfs\_api.ifs.level0prc module ------------------------------------ - -.. automodule:: csst_dfs_api.ifs.level0prc - :members: - :undoc-members: - :show-inheritance: - -csst\_dfs\_api.ifs.level1 module --------------------------------- - -.. automodule:: csst_dfs_api.ifs.level1 - :members: - :undoc-members: - :show-inheritance: - -csst\_dfs\_api.ifs.level1prc module ------------------------------------ - -.. automodule:: csst_dfs_api.ifs.level1prc - :members: - :undoc-members: - :show-inheritance: - Module contents --------------- diff --git a/docs/source/rst/csst_dfs_api.mbi.rst b/docs/source/rst/csst_dfs_api.mbi.rst new file mode 100644 index 0000000000000000000000000000000000000000..90b38fb1f8822f4658e2f836f40126b8d01a6ba1 --- /dev/null +++ b/docs/source/rst/csst_dfs_api.mbi.rst @@ -0,0 +1,29 @@ +csst\_dfs\_api.mbi package +========================== + +Submodules +---------- + +csst\_dfs\_api.mbi.level2 module +-------------------------------- + +.. automodule:: csst_dfs_api.mbi.level2 + :members: + :undoc-members: + :show-inheritance: + +csst\_dfs\_api.mbi.level2co module +---------------------------------- + +.. automodule:: csst_dfs_api.mbi.level2co + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: csst_dfs_api.mbi + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/rst/csst_dfs_api.mci.rst b/docs/source/rst/csst_dfs_api.mci.rst index 9e24b0ac4947b247d69e34e9d9025a197af2d98d..9285d4a979e8e2317accaeab7bcdf857075d3624 100644 --- a/docs/source/rst/csst_dfs_api.mci.rst +++ b/docs/source/rst/csst_dfs_api.mci.rst @@ -1,49 +1,6 @@ csst\_dfs\_api.mci package ========================== -Submodules ----------- - -csst\_dfs\_api.mci.calmerge module ----------------------------------- - -.. automodule:: csst_dfs_api.mci.calmerge - :members: - :undoc-members: - :show-inheritance: - -csst\_dfs\_api.mci.level0 module --------------------------------- - -.. automodule:: csst_dfs_api.mci.level0 - :members: - :undoc-members: - :show-inheritance: - -csst\_dfs\_api.mci.level0prc module ------------------------------------ - -.. automodule:: csst_dfs_api.mci.level0prc - :members: - :undoc-members: - :show-inheritance: - -csst\_dfs\_api.mci.level1 module --------------------------------- - -.. automodule:: csst_dfs_api.mci.level1 - :members: - :undoc-members: - :show-inheritance: - -csst\_dfs\_api.mci.level1prc module ------------------------------------ - -.. automodule:: csst_dfs_api.mci.level1prc - :members: - :undoc-members: - :show-inheritance: - Module contents --------------- diff --git a/docs/source/rst/csst_dfs_api.rst b/docs/source/rst/csst_dfs_api.rst index c3a57c829378f3133049b061845ff9237d59a912..847239d430cb3a10bbee10c6d7a14e0d1b80bd79 100644 --- a/docs/source/rst/csst_dfs_api.rst +++ b/docs/source/rst/csst_dfs_api.rst @@ -10,10 +10,11 @@ Subpackages csst_dfs_api.common csst_dfs_api.cpic csst_dfs_api.facility + csst_dfs_api.functional csst_dfs_api.hstdm csst_dfs_api.ifs + csst_dfs_api.mbi csst_dfs_api.mci - csst_dfs_api.msc csst_dfs_api.sls Module contents diff --git a/docs/source/rst/csst_dfs_api.sls.rst b/docs/source/rst/csst_dfs_api.sls.rst index 84235e8d63ff18bd7aa0191dcdbbb6916e33b135..cde9a845c43707f8dbcdaf9a6dd3d831e0e51667 100644 --- a/docs/source/rst/csst_dfs_api.sls.rst +++ b/docs/source/rst/csst_dfs_api.sls.rst @@ -4,46 +4,6 @@ csst\_dfs\_api.sls package Submodules ---------- -csst\_dfs\_api.sls.calmerge module ----------------------------------- - -.. automodule:: csst_dfs_api.sls.calmerge - :members: - :undoc-members: - :show-inheritance: - -csst\_dfs\_api.sls.level0 module --------------------------------- - -.. automodule:: csst_dfs_api.sls.level0 - :members: - :undoc-members: - :show-inheritance: - -csst\_dfs\_api.sls.level0prc module ------------------------------------ - -.. automodule:: csst_dfs_api.sls.level0prc - :members: - :undoc-members: - :show-inheritance: - -csst\_dfs\_api.sls.level1 module --------------------------------- - -.. automodule:: csst_dfs_api.sls.level1 - :members: - :undoc-members: - :show-inheritance: - -csst\_dfs\_api.sls.level1prc module ------------------------------------ - -.. automodule:: csst_dfs_api.sls.level1prc - :members: - :undoc-members: - :show-inheritance: - csst\_dfs\_api.sls.level2spectra module --------------------------------------- diff --git a/requirements.txt b/requirements.txt index e3bbb376a7f87fd874cd9f4709548d11b2ff1435..130465f8963a0dcf1c912f0401445a1a304dd079 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,10 @@ astropy>=4.0 -git+https://github.com/astronomical-data-processing/csst-dfs-commons.git \ No newline at end of file +grpcio>=1.28.1 +grpcio_tools>=1.28.1 +protobuf==3.9.0 +pandas>=1.2.4 +networkx>=2.4 +matplotlib>=3.4.1 +numpy>=1.20.1 +astropy_healpix==0.7 +DBUtils==1.3 \ No newline at end of file diff --git a/tests/common/test_common_catalog.py b/tests/common/test_common_catalog.py index e4efb03a4677b9e28d47ba3d701d351365faf53a..da650f4f5c6e5b397e5c583a374e5ed90dec3867 100644 --- a/tests/common/test_common_catalog.py +++ b/tests/common/test_common_catalog.py @@ -21,9 +21,10 @@ class CommonCatalogTestCase(unittest.TestCase): obstime = -1, limit = 0 ) - # print(result) - dt = self.api.to_table(result) - dt.pprint() + print(result) + if result.success: + dt = self.api.to_table(result) + dt.pprint() # df = dt.to_pandas() # print(df.head()) print('used:', time.time()-t)