#104 Merge pull request from deshima-dev/astropenguin/issue103

Release v2.12

CITATION.cff

@@ -1,22 +1,35 @@
-cff-version: 1.2.0
-message: "If you use this software, please cite it as below."
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
 
-title: "demerge"
-abstract: "DESHIMA merge code for observed datasets"
-version: 2.11.0
-date-released: 2023-12-07
-license: "MIT"
-doi: "10.5281/zenodo.10015892"
-url: "https://github.com/deshima-dev/demerge"
+cff-version: 1.2.0
+title: demerge
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+type: software
 authors:
-  - given-names: "Tatsuya"
-    family-names: "Takekoshi"
-    affiliation: "Kitami Institute of Technology"
-    orcid: "https://orcid.org/0000-0002-4124-797X"
-  - given-names: "Daisuke"
-    family-names: "Naito"
-    affiliation: "Naito Systems"
-  - given-names: "Akio"
-    family-names: "Taniguchi"
-    affiliation: "Nagoya University"
-    orcid: "https://orcid.org/0000-0002-9695-6183"
+  - given-names: Tatsuya
+    family-names: Takekoshi
+    affiliation: Kitami Institute of Technology
+    orcid: 'https://orcid.org/0000-0002-4124-797X'
+  - given-names: Daisuke
+    family-names: Naito
+    affiliation: Naito Systems
+  - given-names: Akio
+    family-names: Taniguchi
+    affiliation: Nagoya University
+    orcid: 'https://orcid.org/0000-0002-9695-6183'
+identifiers:
+  - type: doi
+    value: 10.5281/zenodo.10015892
+repository-code: 'https://github.com/deshima-dev/demerge'
+abstract: DESHIMA merge code for observed datasets
+keywords:
+  - astronomy
+  - radio-astronomy
+  - submillimeter
+  - spectroscopy
+  - deshima
+license: MIT
+version: 2.12.0
+date-released: '2024-04-03'

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021-2023 DESHIMA Team
+Copyright (c) 2021-2024 DESHIMA Team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -13,7 +13,7 @@ MergeToDfits()クラスの代わりとなるmerge_to_dems()関数を実装し、
 ## 動作環境
 
 - CPython: 3.9-3.12
-- Dependent packages: [pyproject.toml](https://github.com/deshima-dev/demerge/blob/v2.11.0/pyproject.toml)をご確認ください
+- Dependent packages: [pyproject.toml](https://github.com/deshima-dev/demerge/blob/v2.12.0/pyproject.toml)をご確認ください
 
 ## インストール
 
@@ -22,7 +22,7 @@ MergeToDfits()クラスの代わりとなるmerge_to_dems()関数を実装し、
 pipで[PyPI](https://pypi.org)からインストールしてください。
 
 ```shell
-pip install demerge==2.11.0
+pip install demerge==2.12.0
 ```
 
 インストール後、`demerge`コマンドが利用可能になります。
@@ -34,11 +34,11 @@ pip install demerge==2.11.0
 ```shell
 # テストデータを含める場合
 git clone --recursive https://github.com/deshima-dev/demerge.git
-cd demerge && git checkout v2.11.0
+cd demerge && git checkout v2.12.0
 
 # 最小構成でダウンロードする場合
 git clone --depth=1 https://github.com/deshima-dev/demerge.git
-cd demerge && git checkout v2.11.0
+cd demerge && git checkout v2.12.0
 ```
 
 続けて、`demerge`パッケージのPython環境へのインストールを行います。
@@ -85,6 +85,7 @@ deshima-rawdata list
 `-c` | キャッシュディレクトリを指定 | `cache`
 `-g` | グラフディレクトリを指定 | `graph`
 `-b` | DDBファイルを指定 | `dmerge/ddb_20231123.fits.gz`（パッケージに同梱）
+`-i` | Master-to-KID ID対応ファイルを指定 | なし（なしの場合、DDBファイル中の対応関係を使用）
 `-o` | 出力データディレクトリを指定 | `cache`
 `-m` | マージオプションを指定（例：`-m "--coordinate radec"`） | なし
 
@@ -193,6 +194,7 @@ python -m unittest       # merge_to_dems関数およびmerge_functionモジュ
 merge_to_dems()関数が定義されています。この関数は以下の8つのファイルからDEMSオブジェクトを生成します。
 
  - DDBファイル(.fits.gz)
+ - Master-to-KID ID対応ファイル(.json)
  - obsファイル(.obs)
  - antennaファイル(.ant)
  - skychopファイル(.skychop)
@@ -201,7 +203,7 @@ merge_to_dems()関数が定義されています。この関数は以下の8つ
  - cabinファイル(.cabin)
  - reduced readoutファイル(.fits)
 
-reduced readoutファイルはdemerge/run.shを実行することによって生成されます。DDBファイルはdemergeのリポジトリに含まれているキャリブレーションデータです。その他のファイル(obs, antenna, skychop, weather, misti, cabin)は観測とともに得られるデータです。
+reduced readoutファイルはdemerge/run.shを実行することによって生成されます。DDBファイルはdemergeのリポジトリに含まれているキャリブレーションデータです。その他のファイルは観測とともに得られるデータです。
 
 merge_to_dems()関数は以下の必須引数とオプション引数をとることができます。
 
@@ -211,6 +213,7 @@ merge_to_dems()関数は以下の必須引数とオプション引数をとる
 --- | --- | ---
 `filename` | 文字列 | 出力ファイルへのパスを指定して下さい(.zarr.zip)
 `--ddb` | 文字列 | DDBファイルへのパスを指定して下さい(.fits.gz)
+`--corresp` | 文字列 | Master-to-KID ID対応ファイルへのパスを指定して下さい(.json)
 `--obs` | 文字列 | obsファイルへのパスを指定して下さい(.obs)
 `--antenna` | 文字列 | antennaファイルへのパスを指定して下さい(.antenna)
 `--readout` | 文字列 | reduced readoutファイルへのパスを指定して下さい(.fits)

demerge/__init__.py

@@ -7,7 +7,7 @@
     "merge_to_dems",
     "plot",
 ]
-__version__ = "2.11.0"
+__version__ = "2.12.0"
 
 
 # submodules

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "demerge"
-version = "2.11.0"
+version = "2.12.0"
 description = "DESHIMA merge code for observed datasets"
 authors = [
     "Tatsuya Takekoshi <[email protected]>",