You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-14Lines changed: 13 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,20 +29,20 @@ The MSIBI package is designed to be very object oriented. Any force optimization
29
29
30
30
MSIBI uses [Hoomd-Blue](https://hoomd-blue.readthedocs.io/en/latest/) to run optimization simulations. It is not required that you be familiar with Hoomd to use MSIBI as the simulation script is automatically generated and ran. However, it is required that you pass in the choice of [Hoomd method](https://hoomd-blue.readthedocs.io/en/latest/module-md-methods.html), [Hoomd neighbor list](https://hoomd-blue.readthedocs.io/en/latest/module-md-nlist.html), and [Hoomd thermostat](https://hoomd-blue.readthedocs.io/en/latest/module-md-methods-thermostats.html) to the `msibi.optimize.MSIBI` class. Since MSIBI utilizes Hoomd-Blue, this means that MSIBI can run on GPUs, see [Hoomd's installation guide](https://hoomd-blue.readthedocs.io/en/latest/installation.html) for instructions on ensuring your environment includes a GPU build of hoomd.
31
31
32
-
### Quick Example:
32
+
### Quick Example: Optimizing bond-stretching
33
33
Here is a simple example using MSIBI to learn a bond-stretching force from a single state point:
34
34
35
35
```python
36
36
# This is the context/management class for MSIBI
37
37
# Set simulation parameters, call `add_state` and `add_force` methods to store other MSIBI objects.
- Here is an example of learning a pair potential using multiple state points and forces.
76
75
- In this example, we set fixed bond and angle potentials that are included during iteration simulations.
77
76
- The bond potential will set a fixed harmonic force, while the angle potential will be set from a table potential file.
78
77
- This illustrates a use case of stringing together multiple MSIBI optimizations.
79
-
- For example, one MSIBI optimization can be used to learn and obtain a coarse-grained angle potential table file which can then be set and held fixed while learning pair potentials in a subsequent MSIBI optimization.
78
+
- For example, one MSIBI optimization can be used to learn and obtain a coarse-grained angle potential table file which can then be set and held fixed while learning pair potentials in a subsequent MSIBI optimization.
0 commit comments