Supplemental Data for RECSA

Description in English

This ZIP file contains three usage examples of the Python package RECSA.RECSA: https://github.com/Hiraoka-Group/recsa/tree/v0.3.0 

The examples are for M2L4, M4L4, and M9L6, each organized into a separate folder. Therefore, the root directory of the ZIP file includes the following folders:- M2L4- M4L4- M9L6

Each of these three folders contains two subfolders: assets and output.

assets Folder

The assets folder contains input files required for the program, as described below:- additional_assems.yaml: Defines additional structures to be included beyond the assemblies enumerated during substructure enumeration. Typically, these include initial complexes (MXn), free multitopic ligands (L), and free leaving ligands (X).- bond_based_structure.yaml: Defines assemblies in bond-based description. This is used in Step 1 of the enumeration process.- comp_kinds.yaml: Defines the types of components, such as metal ions, multitopic ligands, and leaving ligands. These correspond to the Component objects in the RECSA package.- structure.yaml: Defines assemblies focusing on the components. This is used in Step 2 of the enumeration process.

output Folder

The output folder contains the output files generated by the program, as described below:- assemblies.yaml: Contains the enumerated assemblies. These correspond to the Assembly objects in the RECSA package.- reactions.csv: Lists the enumerated elementary reactions. Each row represents one elementary reaction (forward and reverse reactions are treated separately).- assembly_imgs: A folder containing diagrams (PDF format) of the enumerated assemblies. These diagrams are generated using the draw_2d and draw_3d functions of the RECSA package. However, the assembly_imgs folder is not included for M9L6 due to the large number of assemblies.

Note that, at present, the RECSA package itself does not support file input and output. Users need to handle file input and output on their own, using tools such as PyYAML or pandas.

Note: YAML files can be opened using a standard text editor. Alternatively, you can change the file extension to .txt to open them.

Description in Japanese (日本語による説明)

このZIPファイルはRECSAというPythonパッケージの利用例を三つ含んでいます。RECSA: https://github.com/Hiraoka-Group/recsa/tree/v0.3.0

例はM2L4、M4L4、M9L6で、それぞれ一つずつのフォルダになっています。つまり、ZIPファイルのルートディレクトリには、以下のフォルダがあります。- M2L2- M4L4- M9L6

これらの三つのフォルダの各々はassetsフォルダとoutputフォルダを含みます。assetsフォルダはプログラムの入力ファイル、outputフォルダは出力ファイルを格納しています。

assetsフォルダは以下のファイルを含みます。- additional_assems.yaml:部分構造列挙で列挙される集合体以外で追加したい構造を定義しています。典型的には、原料錯体(MXn)・フリーの多座配位子(L)・フリーの脱離配位子(X)です。- bond_based_structure.yaml:結合に注目した集合体構造の定義です。列挙の手順1で利用します。- comp_kinds.yaml:構成要素の種類(金属イオン・多座配位子・脱離配位子)のそれぞれの構造を定義しています。RECSAパッケージのComponentオブジェクトに対応します。- structure.yaml:構成要素に注目した集合体構造の定義です。列挙の手順2で利用します。

outputフォルダは以下のファイル・フォルダを含みます。- assemblies.yaml:列挙された集合体です。RECSAパッケージのAssemblyオブジェクトに対応しています。- reactions.csv:列挙された素反応です。一行が一つの素反応(正反応と逆反応は個別に扱われている)を表します。- assembly_imgs:列挙された集合体を描画した図(PDF)を含んだフォルダです。RECSAパッケージの draw_2d および draw_3d 関数を用いて描画しています。ただし M9L6 は集合体が多すぎるためこのフォルダを含んでいません。

ただし、現状ではRECSAパッケージ自体はファイルの入出力はサポートしていません。ユーザーが自身で(PyYAMLやpandasなどを用いて)ファイルの入出力を行う必要があります。

補足:YAMLファイルは通常のテキストエディタで開くことができます。あるいは拡張子を txt に変更して開いてください。