Skip to content

Commit c5a31b7

Browse files
authored
Revise README for version 1.20.3 updates
Updated installation instructions and version numbers in README.
1 parent 030335e commit c5a31b7

1 file changed

Lines changed: 54 additions & 17 deletions

File tree

README.md

Lines changed: 54 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# MultiOptPy
22

3-
43
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1wpW8YO8r9gq20GACyzdaEsFK4Va1JQs4?usp=sharing) (Test 1, only use GFN2-xTB)
54

65

@@ -12,7 +11,6 @@
1211
[![PyPI Downloads](https://static.pepy.tech/personalized-badge/multioptpy?period=total&units=INTERNATIONAL_SYSTEM&left_color=BLACK&right_color=GREEN&left_text=downloads)](https://pepy.tech/projects/multioptpy)
1312
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.17839100.svg)](https://doi.org/10.5281/zenodo.17839100)
1413

15-
1614
If this tool helped your studies, education, or saved your time, I'd appreciate a coffee!
1715
Your support serves as a great encouragement for this personal project and fuels my next journey.
1816
I also welcome contributions, bug reports, and pull requests to improve this tool.
@@ -35,11 +33,14 @@ This program can also automatically calculate the transition-state structure fro
3533

3634
[![MultiOptPy Demo](https://img.youtube.com/vi/AE61iY2HZ8Y/0.jpg)](https://www.youtube.com/watch?v=AE61iY2HZ8Y)
3735

36+
3837
## Features
3938

4039
- It is intended to be used in a linux environment.
4140
- It can be used not only with AFIR functions, but also with other bias potentials.
4241

42+
43+
4344
## Quick Start (for Linux)
4445
```
4546
# Below is an example showing how to use GFN2-xTB to calculate a transition-state structure.
@@ -59,9 +60,9 @@ conda create -n test_mop python=3.12.7
5960
conda activate test_mop
6061
6162
## 3. Download and install MultiOptPy:
62-
wget https://github.com/ss0832/MultiOptPy/archive/refs/tags/v1.20.0.zip
63-
unzip v1.20.0.zip
64-
cd MultiOptPy-1.20.0
63+
wget https://github.com/ss0832/MultiOptPy/archive/refs/tags/v1.20.3.zip
64+
unzip v1.20.3.zip
65+
cd MultiOptPy-1.20.3
6566
pip install -r requirements.txt
6667
6768
## 4. Copy the test configuration file and run the AutoTS workflow:
@@ -86,7 +87,10 @@ python run_autots.py aldol_rxn.xyz -cfg config_autots_run_xtb_test.json
8687
# Installation via pip (Linux)
8788
conda create -n <env-name> python=3.12 pip
8889
conda activate <env-name>
89-
pip install git+https://github.com/ss0832/MultiOptPy.git@v1.20.2
90+
pip install git+https://github.com/ss0832/MultiOptPy.git@v1.20.3
91+
wget https://github.com/ss0832/MultiOptPy/archive/refs/tags/v1.20.3.zip
92+
unzip v1.20.3.zip
93+
cd MultiOptPy-1.20.3
9094
9195
## 💻 Command Line Interface (CLI) Functionality (v1.20.2)
9296
# The following eight core functionalities are available as direct executable commands in your terminal after installation:
@@ -131,34 +135,61 @@ References are given in the source code.
131135
## Usage
132136

133137
After downloading the repository using git clone or similar commands, move to the generated directory and run the following:
134-
138+
python command
135139
```
136140
python optmain.py SN2.xyz -ma 150 1 6 -pyscf -elec 0 -spin 0 -opt rsirfo_block_fsb -modelhess
137141
```
142+
CLI command (arbitrary directory)
143+
```
144+
optmain SN2.xyz -ma 150 1 6 -pyscf -elec 0 -spin 0 -opt rsirfo_block_fsb -modelhess
145+
```
146+
python command
138147
```
139148
python optmain.py aldol_rxn.xyz -ma 95 1 5 50 3 11 -pyscf -elec 0 -spin 0 -opt rsirfo_block_fsb -modelhess
140149
```
141-
For SADDLE calculation
150+
CLI command (arbitrary directory)
142151
```
143-
python optmain.py aldol_rxn_PT.xyz -xtb GFN2-xTB -opt RSIRFO_bofill -order 1 -fc 5
152+
optmain aldol_rxn.xyz -ma 95 1 5 50 3 11 -pyscf -elec 0 -spin 0 -opt rsirfo_block_fsb -modelhess
144153
```
145154

146-
For NEB method
155+
For SADDLE calculation
147156

157+
python command
158+
```
159+
python optmain.py aldol_rxn_PT.xyz -xtb GFN2-xTB -opt rsirfo_block_bofill -order 1 -fc 5
160+
```
161+
CLI command (arbitrary directory)
162+
```
163+
optmain aldol_rxn_PT.xyz -xtb GFN2-xTB -opt rsirfo_block_bofill -order 1 -fc 5
164+
```
165+
##### For NEB method
166+
python command
148167
```
149168
python nebmain.py aldol_rxn -xtb GFN2-xTB -ns 50 -adpred 1 -nd 0.5
150169
```
170+
CLI command (arbitrary directory)
171+
```
172+
nebmain aldol_rxn -xtb GFN2-xTB -ns 50 -adpred 1 -nd 0.5
173+
```
151174

152-
For iEIP method
153-
175+
##### For iEIP method
176+
python command
154177
```
155178
python ieipmain.py ieip_test -xtb GFN2-xTB
156179
```
157-
For Molecular Dynamics (MD)
158-
180+
CLI command (arbitrary directory)
181+
```
182+
ieipmain ieip_test -xtb GFN2-xTB
183+
```
184+
##### For Molecular Dynamics (MD)
185+
python command
159186
```
160187
python mdmain.py aldol_rxn_PT.xyz -xtb GFN2-xTB -temp 298 -traj 1 -time 100000
161188
```
189+
CLI command (arbitrary directory)
190+
```
191+
mdmain aldol_rxn_PT.xyz -xtb GFN2-xTB -temp 298 -traj 1 -time 100000
192+
```
162193
(Default deterministic algorithm for MD is Nosé–Hoover thermostat.)
163194

164195
For orientation search
@@ -171,7 +202,7 @@ python conformation_search.py s8_for_confomation_search_test.xyz -xtb GFN2-xTB -
171202
```
172203
For relaxed scan (Similar to functions implemented in Gaussian)
173204
```
174-
python relaxed_scan.py SN2.xyz -nsample 8 -scan bond 1,2 1.3,2.6 -elec -1 -spin 0 -pyscf
205+
python relaxed_scan.py SN2.xyz -nsample 8 -scan bond 1,2 1.3,2.6 -elec -1 -spin 0 -os GFN0-xTB -opt crsirfo_block_fsb -modelhess
175206
```
176207
## Options
177208
(optmain.py)
@@ -418,15 +449,15 @@ Download **uma-s-1p1.pt** from the following page:
418449

419450
### 2. Add the Model Path to MultiOptPy
420451

421-
Open the file `software_path.conf` inside the **MultiOptPy-v1.20.0-rc.4** directory.
452+
Open the file `software_path.conf` inside the **MultiOptPy** directory.
422453

423454
Add the following line using the absolute path to the model file:
424455

425456
```
426457
uma-s-1p1::<absolute_path_to/uma-s-1p1.pt>
427458
```
428459

429-
This enables **MultiOptPy-v1.20.0-rc.4** to use the **uma-s-1p1 NNP model**.
460+
This enables **MultiOptPy** to use the **uma-s-1p1 NNP model**.
430461

431462
### references of UMA
432463
- arXiv preprint arXiv:2505.08762 (2025).
@@ -438,3 +469,9 @@ This enables **MultiOptPy-v1.20.0-rc.4** to use the **uma-s-1p1 NNP model**.
438469
conda env create -f environment_win11uma.yml
439470
conda activate test_mop_win11_uma
440471
```
472+
473+
474+
---
475+
476+
> **Status: Maintenance Mode / Frozen**
477+
> *This project has reached its initial stability goals (v1.20.2) and is currently frozen. No new features are planned by the original author, but the codebase remains open for the community to fork and explore the roadmap above.*

0 commit comments

Comments
 (0)