Commit 01f2fe94 authored by BO ZHANG's avatar BO ZHANG 🏀
Browse files

updated README.md

parent bab3424a
Loading
Loading
Loading
Loading
+46 −33
Original line number Diff line number Diff line
@@ -108,6 +108,7 @@ git pull origin main
  - finished `setup.py`
  - can be installed with `pip install <package_name/package_link>` from gitlab
- stage 3:
  - **complete docstrings** for functions & classes
  - finished instruction
  - `README.md`
- stage 4:
@@ -124,22 +125,34 @@ git pull origin main
## progress

| module name                 | stage 1<br>(source code) | stage 2<br>(packaging) | stage 3<br>(instruction) | stage 4<br>(unit tests) | stage 5<br>(gitlab pipeline) | stage 6<br>(sphinx doc) |
|---------------------------|--------------------------|------------------------|--------------------------|-------------------------|------------------------------|-------------------------|
|-----------------------------|--------------------------|------------------------|--------------------------|-------------------------|------------------------------|-------------------------|
| `csst_proto`                | √                        | √                      | √                        | √                       | √                            | √                       |
| `csst_ms_mbi_instrument`  |                          |                        |                          |                         |                              |                         |
| `csst_ms_mbi_instrument`    | √                        |                       |                          |                         |                              |                         |
| `csst_ms_mbi_distortion`    | √                        | √                      | √                        |                         |                              |                         |
| `csst_ms_mbi_position`    |                          |                        |                          |                         |                              |                         |
| `csst_ms_mbi_flux`        |                          |                        |                          |                         |                              |                         |
| `csst_ms_mbi_photometry`  |                          |                        |                          |                         |                              |                         |
| `csst_ms_sls_instrument`  |                          |                        |                          |                         |                              |                         |
| `csst_ms_sls_mosaic`      |                          |                        |                          |                         |                              |                         |
| `csst_ms_sls_position`    |                          |                        |                          |                         |                              |                         |
| `csst_ms_sls_distortion`  |                          |                        |                          |                         |                              |                         |
| `csst_ms_sls_directimage` |                          |                        |                          |                         |                              |                         |
| `csst_ms_sls_sky`         |                          |                        |                          |                         |                              |                         |
| `csst_ms_sls_axe`         |                          |                        |                          |                         |                              |                         |
| `csst_ms_sls_cde`         |                          |                        |                          |                         |                              |                         |
| ``                        |                          |                        |                          |                         |                              |                         |
| `csst_ms_mbi_position`      | √                        | √                      |                          |                         |                              |                         |
| `csst_ms_mbi_flux`          | √                        | √                      |                          |                         |                              |                         |
| `csst_ms_mbi_photometry`    | √                        | √                      |                          |                         |                              |                         |
| `csst_ms_sls_instrument`    | √                        |                        |                          |                         |                              |                         |
| `csst_ms_sls_mosaic`        | √                        |                        |                          |                         |                              |                         |
| `csst_ms_sls_position`      | √                        |                        |                          |                         |                              |                         |
| `csst_ms_sls_directimage`   | √ ️                      |                        |                          |                         |                              |                         |
| `csst_ms_sls_sky`           | √                        |                        |                          |                         |                              |                         |
| `csst_ms_sls_objextraction` | √                        |                        |                          |                         |                              |                         |
| `csst_ms_sls_axe`           | √                        |                        |                          |                         |                              |                         |
| `csst_ms_sls_cde`           | √                        |                        |                          |                         |                              |                         |
| `csst_ms_qc0`               | √                        |                        |                          |                         |                              |                         |
| `csst_cpic`                 | √                        |                        |                          |                         |                              |                         |
| `csst_thz_dp1`              | √                        |                        |                          |                         |                              |                         |
| `csst_mci_distortion`       | √                        |                        |                          |                         |                              |                         |
| `csst_mci_instrument`       | √                        |                        |                          |                         |                              |                         |
| `csst_mci_astrometry`       | √                        |                        |                          |                         |                              |                         |
| `csst_mci_flux`             | √                        |                        |                          |                         |                              |                         |
| `csst_mci_photometry`       | √                        |                        |                          |                         |                              |                         |
| `csst_ifs_rss`              | √                        |                        |                          |                         |                              |                         |
| `csst_ifs_cube`             | √                        |                        |                          |                         |                              |                         |
| `csst_ifs_wcs`              | √                        |                        |                          |                         |                              |                         |




## useful links
@@ -167,30 +180,30 @@ git pull origin main

```python
import os
from csst.ms.data_manager import CsstMscDataManager
from csst.ms.backbone import CCD_ID_LIST
from csst_common.data_manager import CsstMbiDataManager
from csst_common.params import CSST_PARAMS

# initialize data manager
dm = CsstMscDataManager(
dm = CsstMbiDataManager(
    ver_sim="C5.1", dir_l0="/data/sim_data/MSC_0000100", dir_l1="/home/user/L1Pipeline/msc/work")
# process all CCDs
dm.set_ccd_ids(CCD_ID_LIST)
dm.set_detectors()

print("----- available ccd_ids -----")
print(dm.available_ccd_ids)
for ccd_id in dm.target_ccd_ids:
print("----- available detectors -----")
print(dm.available_detectors)
for detector in dm.target_detectors:
    print("----- L0 images -----")
    print(dm.l0_ccd(ccd_id=ccd_id))
    print(os.path.exists(dm.l0_ccd(ccd_id=ccd_id)))
    print(dm.l0_detector(detector=detector))
    print(os.path.exists(dm.l0_ccd(detector=detector)))
    print("----- L0 crs -----")
    print(dm.l0_crs(ccd_id=ccd_id))
    print(os.path.exists(dm.l0_ccd(ccd_id=ccd_id)))
    print(dm.l0_crs(detector=detector))
    print(os.path.exists(dm.l0_ccd(detector=detector)))
    print("----- L0 input cat -----")
    print(dm.l0_cat(ccd_id=ccd_id))
    print(os.path.exists(dm.l0_cat(ccd_id=ccd_id)))
    print(dm.l0_cat(detector=detector))
    print(os.path.exists(dm.l0_cat(detector=detector)))
    print("----- L0 input log -----")
    print(dm.l0_log(ccd_id=ccd_id))
    print(os.path.exists(dm.l0_log(ccd_id=ccd_id)))
    print(dm.l0_log(detector=detector))
    print(os.path.exists(dm.l0_log(detector=detector)))
    print("----- L1 images -----")
    print(dm.l1_ccd(ccd_id, post="img.fits"))
    print(dm.l1_ccd(detector, post="img.fits"))
```
 No newline at end of file