コンポーネントの使用例を探す

TRNSYSには標準コンポーネント、オプションのコンポーネントが多数用意されています。
使い慣れたコンポーネントはともかく、はじめて使うコンポーネントや、普段使わないコンポーネントの使い方って分からないですよね。
ドキュメントで仕様、使い方を調べても、いまいち使い方が分からない事もあります。
そんなときに参考になるのが、多くのコンポーネントに用意されている使用例(Examples)です。
ドキュメント読んでも、やっぱりわからん
使用例には基本的な設定や、他のコンポーネントの組み合わせなど、役に立つ情報が多く含まれています。
ところがこれも数が多くて、目当ての使用例を探し出すのは干し草の山から針を探すような大変さです。
findtype.py
そこで、Type番号を指定して使用例を検索するスクリプトを作成しました。
使い方は以下の動画を見てください。
検索の仕組み
使用例は.tpfとして提供されています。.tpfファイルの中身をPythonで調べることはできないので、いったん.dckファイルへエクスポートしたファイルを対象に検索を行います。
使い方
初期化(.tpfから.dckファイルをエクスポート)
はじめにすべての使用例(.tpfファイル)を.dckファイルへエクスポートします。.dckはテキストファイルです。このfindtypeでは、このファイルからtypeの情報を検索します。
この作業は、初回のみ必須です。
.dckへのエクスポートは”-i”オプションを付けて実行します。
python findtype.py -i
使用例はデフォルトでは以下のフォルダに納められています。(購入しているオプションによります)
- C:\TRNSYS18\Examples
- C:\TRNSYS18\Tess Models\Examples
- C:\TRNSYS18\TRNLib
“-i”オプションを指定すると、これらのフォルダの.tpfを1つずつ開いて、.dckファイルへエクスポートを行います。
この初期化作業はとても時間が掛かります。休憩の前に実行して、コーヒーを飲みながら待ちましょう。
fintypeでtypeを検索する
初期化が終わったら、いよいよ使用例の検索です。Type番号を指定してfindtypeを実行します。
python findtype.py 506
リストアップされた使用例の番号を指定すると、Simulation Studioが起動して.tpfが開かれます。
注意
このスクリプトでは.tpfと.dckが同じ名前であることを前提としています。デフォルトでは.dckファイルの名前は.tpfと同じ名前になりますが、一部の.tpfは異なる.dckファイル名が指定されています。この場合、対応関係が取れなくなります。番号を指定しても.tpfは開かれません。
公開リポジトリ
このスクリプトはリンク先のリポジトリで公開しています。
https://github.com/TRNSYSJP/findtype
実行イメージ(.exeファイル)も用意しています。直接実行したい方はリンク先から実行イメージをダウンロードしてください。
https://github.com/TRNSYSJP/findtype/releases
注:セキュリティ上の理由で.exeファイルのダウンロードが禁止されていることがあります。その場合は面倒でもリポジトリのReadme.mdを参考にお試し下さい。
まとめ
Type番号から使用している.tpf ファイルを探すスクリプトを作成、公開しました。
スクリプトの仕組み上、すべての.tpfには対応できません。それでも使用例を探す効率が劇的に楽になりました。
動作環境
以下の環境で動作を確認しています。
- Windows11 Pro(64bit, 24H2)
- TRNSYS18.06.0002(64bit)
- Python 3.12.4