Skip to content

Commit 02234d0

Browse files
authored
Modify README with climb method and restart example
Updated method call and added restart example in README.
1 parent 28be41b commit 02234d0

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,24 @@ init=read('../init/opt.traj')
2727
final=read('../final/opt.traj')
2828

2929
climber = SaddleClimb(init, final, calc)
30-
climber.run()
30+
climber.climb()
3131
```
32-
To see more details of this example see [here](https://github.com/kirkbadger18/SaddleClimb/tree/main/examples/minimal_using_EMT)
32+
To see more details of this example see: [here](https://github.com/kirkbadger18/SaddleClimb/tree/main/examples/minimal_using_EMT)
33+
If the job gets canceled or fails for some reason, the calculation can be restarted using the `restart_climb()` method. This would look like:
34+
```python
35+
from ase import Atoms, Atom
36+
from ase.io import read
37+
from saddleclimb import SaddleClimb
38+
from ase.calculators.emt import EMT
39+
40+
calc = EMT()
41+
init=read('../../init/opt.traj')
42+
final=read('../../final/opt.traj')
43+
restarttraj = read('climb.traj')
44+
climber = SaddleClimb(init, final, calc)
45+
climber.restart_climb(restarttraj)
46+
```
47+
To see more details of restarting a job see: [here](https://github.com/kirkbadger18/SaddleClimb/tree/main/examples/minimal_using_EMT/saddleclimb/with_restart)
3348
## SaddleClimb output
3449
The output from Saddleclimb is two files: climb.log, and climb.traj. In climb.log, the iteration number, energy, and fmax values are stored after each gradient call to the ASE calculator supplied. For the above example this looks like:
3550
```

0 commit comments

Comments
 (0)