gtool4 規約 version 4.0beta

2. データセット全体にかかわる規定

2000/01/24 19:08 豊田英司


本章には数値データと図形オブジェクトのどちらを格納する場合にもあてはまる規定を挙げる。

ファイル名

ファイル名は ".nc" で終わらなければならない。

ファイルの可搬性に考慮して[注]、ファイル名は数字、英小文字、そして下線で構成することを強く推奨する。ファイル名は末尾の ".nc" を除いて 8文字以内にとどめることを推奨する。8文字以内にとどめることができない場合には、32 文字以内にとどめることを強く推奨する。

ファイル名に英小文字を使用することができない環境では、英大文字を代わりに用いることができる。

変数名

変数名は netCDF ライブラリに許容される変数名でなければならない。

混乱を防ぐため、英大文字と英小文字の相違を無視すると同一になってしまう2つの名前 (たとえば "T" と "t") を持った変数を作らないことを強く推奨する。

大域属性

規約情報

以下の大域属性 Conventions, gt_version を与えねばならない:

:Conventions = "http://www.gfd-dennou.org/arch/gtool4/conventions/";
:gt_version = "4.0beta";

(参考) GDT 規約への互換性を考慮する場合、大域属性 appendices を与えてもよい[注]。もし与えるならば、float 型で数値 1.3 (または最新の GDT 規約版数) とする。

:appendices = 1.3f;

表題

すべてのファイルには大域属性 title を与えねばならない。

大域属性 title にはファイルに含まれる数値データの短い説明を与えるべきである。数値モデルのランの名称や観測・実験番号などが考えられる。

title 属性を機械的に生成するには、所属するデータ変数の long_name を列挙したものを付与することが考えられる。

(参考) ファイルの長い記述的な説明は大域属性 comment に格納するのがよい。

作成者情報

すべてのファイルには source 属性を与えねばならない。また、institution 属性を与えることを推奨する。

source 属性には数値データが最初に netCDF 形式で作成されたときの観測手段、データアーカイブ名、またはソフトウェア名が記入されるべきである。

この属性を機械的に生成するには、もし source 属性が何らかの手段で与えられていればそれを保存し、存在しなければソフトウェアの名称を与えるようにすることが考えられる。

institution 属性にはファイルの最終変更を行った者の名称が記入されるべきである。データがある機関の事業として供給されるならば、その機関の名称が記入されるべきである。また個人の作業としてファイルが作成されるならば、その個人の実名やログイン名が記入されるべきである。

この属性を機械的に生成するには、特に指示がない限り作業者のログイン名と (可能ならば) 作業を行った機械の名前を記録することが考えられる。

GDT 規約への互換性を考慮する場合、source 属性値を production 属性としても与えておくことを推奨する。

編集履歴

大域属性 history に編集履歴を追加しなければならない。

履歴に追加すべき文字列は、日時、スペース、ユーザ名、"> ", コマンドライン、改行である。必要な情報が取得できない場合は空文字列でよい。

たとえば既存の history が

:history = "1999-12-21T01:20:20+0900 toyoda> agcm5.exe\n";

となっているデータファイルを "gtset ofs=+1000" というコマンドで編集した場合は

:history = "1999-12-21T10:23:41+09:00 toyoda> agcm5.exe\n",
    "2000-01-20T14:21:20+09:00 toyoda> gtset ofs=+1000\n";

となる。

より信頼できる[注]履歴保存法として、gt_history_branch を用いることを推奨する。