Skip to content

Commit

Permalink
docs/examples fix (#140)
Browse files Browse the repository at this point in the history
* DMC_fix

* udpate gitignore and delete .idea cache

---------

Co-authored-by: Yingze Wang <[email protected]>
  • Loading branch information
VINFeng and Ericwang6 authored Nov 8, 2023
1 parent e0b0f15 commit 8ffb4fb
Show file tree
Hide file tree
Showing 40 changed files with 53 additions and 14,748 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -789,3 +789,6 @@ FodyWeavers.xsd
# debugging ipynb
debug.ipynb
test.xml

# PyCharm Cache
.idea/
2 changes: 1 addition & 1 deletion docs/dev_guide/generator.ipynb

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion docs/user_guide/1.introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ In this user guide, you will learn:
- [New modules release](./4.modules.md)
- [Advanced examples](./DMFF_example.ipynb) of DMFF, which can help you quickly get started with DMFF


The first thing you should know is that DMFF is not an actual force field model (such as OPLS or AMBER), but a differentiable implementation of various force field (or "potential") functional forms. It contains following modules:

- Classical module: implements classical force fields (OPLS or GAFF like potentials)
Expand Down
14 changes: 7 additions & 7 deletions docs/user_guide/4.modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

In this part, you will see 7 modules of DMFF, some of which are newly released in version 1.0.0. Let's get started with them:

+ [Classical](docs/user_guide/4.1classical.md)
+ [ADMP](docs/user_guide/4.2ADMPPmeForce.md)
+ [Qeq](docs/user_guide/4.3ADMPQeqForce.md)
+ [Machine Learning](docs/user_guide/4.4MLForce.md)
+ [Optimization](docs/user_guide/4.5Optimization.md)
+ [Mbar Estimator](docs/user_guide/4.6MBAR.md)
+ [OpenMM Plugin](docs/user_guide/4.7OpenMMplugin.md)
+ [Classical](./4.1classical.md)
+ [ADMP](./4.2ADMPPmeForce.md)
+ [Qeq](./4.3ADMPQeqForce.md)
+ [Machine Learning](./4.4MLForce.md)
+ [Optimization](./4.5Optimization.md)
+ [Mbar Estimator](./4.6MBAR.md)
+ [OpenMM Plugin](./4.7OpenMMplugin.md)
Binary file added examples/DMC/init.dcd
Binary file not shown.
19 changes: 19 additions & 0 deletions examples/DMC/lj.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<ForceField>
<AtomTypes>
<Type element="C" name="cm" class="cm" mass="15.035"/>
<Type element="C" name="co" class="co" mass="60.008"/>
</AtomTypes>
<Residues>
<Residue name="DMC">
<Atom name="CM1" type="cm"/>
<Atom name="CM2" type="cm"/>
<Atom name="CO" type="co"/>
<Bond atomName1="CM1" atomName2="CO"/>
<Bond atomName1="CM2" atomName2="CO"/>
</Residue>
</Residues>
<LennardJonesForce lj14scale="0.50000">
<Atom type="cm" sigma="0.50" epsilon="0.75" charge="0.2841"/>
<Atom type="co" sigma="0.50" epsilon="0.75" charge="-0.5682"/>
</LennardJonesForce>
</ForceField>
23 changes: 23 additions & 0 deletions examples/DMC/res.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<ForceField>
<AtomTypes>
<Type element="C" name="cm" class="cm" mass="15.035"/>
<Type element="C" name="co" class="co" mass="60.008"/>
</AtomTypes>
<Residues>
<Residue name="DMC">
<Atom name="CM1" type="cm"/>
<Atom name="CM2" type="cm"/>
<Atom name="CO" type="co"/>
<Bond atomName1="CM1" atomName2="CO"/>
<Bond atomName1="CM2" atomName2="CO"/>
</Residue>
</Residues>
<HarmonicBondForce>
<Bond class1="cm" class2="co" length="0.141000" k="267776.000000"/>
</HarmonicBondForce>
<HarmonicAngleForce>
<Angle class1="cm" class2="co" class3="cm" angle="2.062630" k="584.923200"/>
</HarmonicAngleForce>
<NonbondedForce coulomb14scale="0.5" lj14scale="0.5">
</NonbondedForce>
</ForceField>
24 changes: 0 additions & 24 deletions examples/mbar/ben-prm.xml

This file was deleted.

7 changes: 0 additions & 7 deletions examples/mbar/ben-top.xml

This file was deleted.

4 changes: 0 additions & 4 deletions examples/mbar/ben.pdb

This file was deleted.

106 changes: 0 additions & 106 deletions examples/mbar/benz.txt

This file was deleted.

Loading

0 comments on commit 8ffb4fb

Please sign in to comment.