Metadata-Version: 2.4
Name: rccsdmfg16sub
Version: 1.0.0
Summary: A g16sub wrapper enabling dmf-g16 at RCCS, Okazaki
Author-email: Shin-ichi Koda <koda@ims.ac.jp>
License: MIT License
        
        Copyright (c) 2025 Shin-ichi Koda
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/shin1koda/rccs-dmf-g16sub
Project-URL: Source, https://github.com/shin1koda/rccs-dmf-g16sub
Project-URL: Issues, https://github.com/shin1koda/rccs-dmf-g16sub/issues
Keywords: reaction path,transition state,Gaussian,MaxFlux,chemistry
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: Chemistry
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# dmf-g16sub: DMF用 g16sub ラッパー （岡崎スパコン専用）

## Overview

 - Direct MaxFlux 法 (DMF)という名の両端指定型遷移状態探索法を行うためのものです
 - `dmf-g16` というGaussianを使ってDMFを簡便に実行するアプリがあります
 - 一方、岡崎のスパコンには `g16sub` というスパコンの設定込みで簡便にGaussianを実行するコマンドがあります
 - この `dmf-g16sub` は `g16sub` 同様の使用方法で `dmf-g16` を実行するコマンドです

**注意**

`dmf-g16sub` は甲田個人が作成したものであり、スパコン公式のものではありません。問い合わせは計算センターではなく koda at ims.ac.jp にお願いします。

## Requirements

特にないです。


## Installation

次の2行を実行してください。スパコンのファイルシステムの構成の都合で、多少時間がかかります。

```bash
python3.9 -m pip install --user -U rccsdmfg16sub
dmf-g16install
```

- Python パッケージ `rccsdmfg16sub` は依存関係が何もないので直でインストールしても環境をほとんど汚しません。それを避けたい方は仮想環境をおつくり下さい。
- コマンド `dmf-g16` は自動で `dmfg16` という名の `dmf-g16` 用 conda 仮想環境を構築するものです。自前で仮想環境を用意する場合も名前は `dmfg16` にしてください。

## Usage

`g16sub` を `dmf-g16sub` に置き換えるだけです。QST2/3のインプットを与えると `dmf-g16` を使ってTS探索をします。スパコンの設定等も `g16sub` 同様に自動で行います。

```bash
dmf-g16sub QST.com
```

## Options

 - `g16sub` と同じオプションを同じ意味で使えます。
 - `dmf-g16` のオプションは冒頭に `--dmf-` を付ければ使えます（ただし `--exe`と`--dir`は固定のため使えません）

**例**  

インプットや投稿スクリプトを作成するだけ & DMF のエネルギー評価点を5に設定

```bash
dmf-g16sub -P --dmf-npoints 5 QST.com
```

## Citation

`dmf-g16sub`をご利用の際は`dmf-g16` の論文（使用方法の詳細もこちら）を引用して頂けると幸いです

 1. S.-i. Koda and  S. Saito, dmf-g16: A Gaussian Wrapper for Reliable Double-Ended Transition-State Searches with Native Input Formats, ChemRxiv (2025). [doi: 10.26434/chemrxiv.10001592/v1](https://doi.org/10.26434/chemrxiv.10001592/v1)


DMFのベースとなる理論はこちら（任意ですがもし引用して頂けると感謝感激です）

 1. S.-i. Koda and  S. Saito, Locating Transition States by Variational Reaction Path Optimization with an Energy-Derivative-Free Objective Function, JCTC, 20, 2798–2811 (2024). [doi: 10.1021/acs.jctc.3c01246](https://doi.org/10.1021/acs.jctc.3c01246)
 1. S.-i. Koda and  S. Saito, Flat-bottom Elastic Network Model for Generating Improved Plausible Reaction Paths, JCTC, 20, 7176−7187 (2024). [doi: 10.1021/acs.jctc.4c00792](https://doi.org/10.1021/acs.jctc.4c00792)
 1. S.-i. Koda and  S. Saito, Correlated Flat-bottom Elastic Network Model for Improved Bond Rearrangement in Reaction Paths, JCTC, 21, 3513−3522 (2025). [doi: 10.1021/acs.jctc.4c01549](https://doi.org/10.1021/acs.jctc.4c01549)



## License

This project is distributed under the MIT License.

