#44 Merge pull request from deshima-dev/astropenguin/issue43

Release v0.7.0
deshima-dev · Oct 28, 2023 · 705a824 · 705a824
2 parents 497b119 + 7d17b52
commit 705a824
Show file tree

Hide file tree

Showing 4 changed files with 79 additions and 7 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -2,9 +2,9 @@ cff-version: 1.2.0
 message: "If you use this software, please cite it as below."
 
 title: "dems"
-abstract: "DESHIMA measurement set"
-version: 0.6.0
-date-released: 2023-10-20
+abstract: "DESHIMA measurement set by DataArray"
+version: 0.7.0
+date-released: 2023-10-29
 license: "MIT"
 doi: "10.5281/zenodo.8151950"
 url: "https://github.com/deshima-dev/dems"

diff --git a/README.md b/README.md
@@ -6,10 +6,82 @@
 [![DOI](https://img.shields.io/badge/DOI-10.5281/zenodo.8151950-cornflowerblue?style=flat-square)](https://doi.org/10.5281/zenodo.8151950)
 [![Tests](https://img.shields.io/github/actions/workflow/status/deshima-dev/dems/tests.yaml?label=Tests&style=flat-square)](https://github.com/deshima-dev/dems/actions)
 
-DESHIMA measurement set
+DESHIMA measurement set by DataArray
 
 ## Installation
 
 ```shell
 pip install dems
 ```
+
+## Usage
+
+```python
+from dems.d2 import MS
+
+
+da = MS.new(
+    data=[[0.0, ...], ...],
+    mask=[[False, ...], ...],
+    weight=[[1.0, ...], ...],
+    ...
+)
+```
+
+## DataArray specifications
+
+| Category | Variable name | Variable type | Description | Units | Default | Data type | DataArray dims | DataArray dtype |
+|---|---|---|---|---|---|---|---|---|
+| Data | data | Data | Data values | - | - | numpy.ndarray | (time, chan) | - |
+|  | mask | Coordinate | Data masks | - | False | numpy.ndarray | (time, chan) | bool |
+|  | weight | Coordinate | Data weights | - | 1.0 | numpy.ndarray | (time, chan) | float64 |
+|  | long_name | Attribute | Data name | - | "Brightness" | str | - | - |
+|  | units | Attribute | Data units | - | "K" | str | - | - |
+|  | name | Name | DEMS name | - | "DEMS" | str | - | - |
+| Dimensions | time | Dimension | Start time in UTC | - | 1970-01-01T00:00:00.000000000 | numpy.ndarray | (time,) | datetime64[ns] |
+|  | chan | Dimension | Channel ID | - | 0 | numpy.ndarray | (chan,) | int64 |
+| Labels | beam | Coordinate | Beam label | - | "" | numpy.ndarray | (time,) | str |
+|  | scan | Coordinate | Scan label | - | "" | numpy.ndarray | (time,) | str |
+|  | state | Coordinate | State label | - | "" | numpy.ndarray | (time,) | str |
+| Telescope pointing | lon | Coordinate | Sky longitude | deg | 0.0 | numpy.ndarray | (time,) | float64 |
+|  | lat | Coordinate | Sky latitude | deg | 0.0 | numpy.ndarray | (time,) | float64 |
+|  | lon_origin | Coordinate | Reference sky longitude | deg | 0.0 | numpy.ndarray | (time,) | float64 |
+|  | lat_origin | Coordinate | Reference sky latitude | deg | 0.0 | numpy.ndarray | (time,) | float64 |
+|  | frame | Coordinate | Sky coordinate frame | - | "altaz" | numpy.ndarray | () | str |
+| Weather information | temperature | Coordinate | Ground atmospheric temperature | K | 0.0 | numpy.ndarray | (time,) | float64 |
+|  | pressure | Coordinate | Ground atmospheric pressure | Pa | 0.0 | numpy.ndarray | (time,) | float64 |
+|  | humidity | Coordinate | Ground relative humidity | 1 | 0.0 | numpy.ndarray | (time,) | float64 |
+|  | wind_speed | Coordinate | Ground wind speed | m/s | 0.0 | numpy.ndarray | (time,) | float64 |
+|  | wind_direction | Coordinate | Ground wind direction | deg | 0.0 | numpy.ndarray | (time,) | float64 |
+| Data information | bandwidth | Coordinate | Effective channel bandwidth | Hz | 0.0 | numpy.ndarray | (chan,) | float64 |
+|  | frequency | Coordinate | Channel center frequency | Hz | 0.0 | numpy.ndarray | (chan,) | float64 |
+|  | beam_major | Coordinate | Beam major axis | deg | 0.0 | numpy.ndarray | (chan,) | float64 |
+|  | beam_minor | Coordinate | Beam minor axis | deg | 0.0 | numpy.ndarray | (chan,) | float64 |
+|  | beam_pa | Coordinate | Beam position angle | deg | 0.0 | numpy.ndarray | (chan,) | float64 |
+|  | exposure | Coordinate | Sample exposure time | s | 0.00625 | numpy.ndarray | () | float64 |
+|  | interval | Coordinate | Sample interval time | s | 0.00625 | numpy.ndarray | () | float64 |
+| Observation information | observation | Attribute | Observation name | - | "" | str | - | - |
+|  | observer | Attribute | Observer name | - | "" | str | - | - |
+|  | project | Attribute | Project name | - | "" | str | - | - |
+|  | object | Attribute | Object name | - | "" | str | - | - |
+|  | telescope_name | Attribute | Telescope name | - | "ASTE" | str | - | - |
+|  | telescope_diameter | Attribute | Telescope dish diameter | m | 10.0 | float | - | - |
+|  | telescope_coordinates | Attribute | Telescope ITRS coordinates | m | (0.0, 0.0, 0.0) | "tuple[float, float, float]" | - | - |
+| ASTE specific | aste_cabin_temperature | Coordinate | [ASTE] Cabin temperature | K | 0.0 | numpy.ndarray | (time,) | float64 |
+|  | aste_subref_x | Coordinate | [ASTE] Subreflector offset of X axis | mm | 0.0 | numpy.ndarray | (time,) | float64 |
+|  | aste_subref_y | Coordinate | [ASTE] Subreflector offset of Y axis | mm | 0.0 | numpy.ndarray | (time,) | float64 |
+|  | aste_subref_z | Coordinate | [ASTE] Subreflector offset of Z axis | mm | 0.0 | numpy.ndarray | (time,) | float64 |
+|  | aste_subref_xt | Coordinate | [ASTE] Subreflector rotation of X axis | deg | 0.0 | numpy.ndarray | (time,) | float64 |
+|  | aste_subref_yt | Coordinate | [ASTE] Subreflector rotation of Y axis | deg | 0.0 | numpy.ndarray | (time,) | float64 |
+|  | aste_subref_zt | Coordinate | [ASTE] Subreflector rotation of Z axis | deg | 0.0 | numpy.ndarray | (time,) | float64 |
+|  | aste_misti_lon | Coordinate | [ASTE] MiSTI sky longitude | deg | 0.0 | numpy.ndarray | (time,) | float64 |
+|  | aste_misti_lat | Coordinate | [ASTE] MiSTI sky latitude | deg | 0.0 | numpy.ndarray | (time,) | float64 |
+|  | aste_misti_pwv | Coordinate | [ASTE] MiSTI measured PWV | mm | 0.0 | numpy.ndarray | (time,) | float64 |
+|  | aste_misti_frame | Coordinate | [ASTE] MiSTI sky coordinate frame | - | "altaz" | numpy.ndarray | () | str |
+| DESHIMA 2.0 specific | d2_mkid_id | Coordinate | [DESHIMA 2.0] MKID ID | - | 0 | numpy.ndarray | (chan,) | int64 |
+|  | d2_mkid_type | Coordinate | [DESHIMA 2.0] MKID type | - | "" | numpy.ndarray | (chan,) | str |
+|  | d2_mkid_frequency | Coordinate | [DESHIMA 2.0] MKID center frequency | Hz | 0.0 | numpy.ndarray | (chan,) | float64 |
+|  | d2_roomchopper_isblocking | Coordinate | [DESHIMA 2.0] Whether room chopper is blocking sensor | - | False | numpy.ndarray | (time,) | bool |
+|  | d2_skychopper_isblocking | Coordinate | [DESHIMA 2.0] Whether sky chopper is blocking sensor | - | False | numpy.ndarray | (time,) | bool |
+|  | d2_dems_version | Attribute | [DESHIMA 2.0] DEMS version | - | "0.7.0" | str | - | - |
+|  | d2_demerge_version | Attribute | [DESHIMA 2.0] demerge version | - | "2.0.0" | str | - | - |
diff --git a/dems/__init__.py b/dems/__init__.py
@@ -1,5 +1,5 @@
 __all__ = ["d1", "d2"]
-__version__ = "0.6.0"
+__version__ = "0.7.0"
 
 
 # submodules

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "dems"
-version = "0.6.0"
-description = "DESHIMA measurement set"
+version = "0.7.0"
+description = "DESHIMA measurement set by DataArray"
 authors = ["Akio Taniguchi <taniguchi@a.phys.nagoya-u.ac.jp>"]
 license = "MIT"
 readme = "README.md"