Skip to content

Commit

Permalink
update html
Browse files Browse the repository at this point in the history
  • Loading branch information
SangniXun committed Aug 20, 2024
1 parent 9f9c1a3 commit 570e1fd
Show file tree
Hide file tree
Showing 212 changed files with 75,468 additions and 0 deletions.
Binary file added docs/_build/doctrees/advancedTutorial.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/api.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added docs/_build/doctrees/citation.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file added docs/_build/doctrees/index.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/installation.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/tutorial.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/tutorialGUI.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/_build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 6dfb2408176e023e674008b70b83f725
tags: 645f666f9bcd5a90fca523b33c5a78b7
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
18
-3.8580765971568428e+02 neutral napthalene
C 2.4397703245 -0.7099883961 0.0000206200
C 2.4397218526 0.7099981201 0.0000271508
C 1.2475921776 1.4061556571 0.0000203110
C -0.0000128759 0.7189947033 0.0000073141
C -1.2476290200 1.4061688746 0.0000008829
C -2.4397553974 0.7100487925 -0.0000117263
C -2.4397460082 -0.7099448889 -0.0000182422
C -1.2476288777 -1.4062156405 -0.0000121401
C 0.0000138676 -0.7190995078 0.0000006641
C 1.2476602178 -1.4062240260 0.0000074983
H 1.2448250471 -2.4927306634 0.0000020169
H -1.2447711187 -2.4927196649 -0.0000168971
H -3.3840069825 -1.2452230520 -0.0000277743
H -3.3839437525 1.2454155894 -0.0000167697
H -1.2448430780 2.4926825384 0.0000062499
H 1.2447883528 2.4926610011 0.0000242506
H 3.3839630326 1.2452901872 0.0000373621
H 3.3840333383 -1.2452476243 0.0000259290
12,005 changes: 12,005 additions & 0 deletions docs/_build/html/_downloads/462155f4ae6bdfc7b09bb64ddcbd18c8/water_solvated.inpcrd

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
18
naphthalene radical
C 2.4584929186 -0.6980401434 0.0000208854
C 2.4584830542 0.6980208281 0.0000273558
C 1.2392834454 1.4064616303 0.0000201346
C -0.0000127820 0.7187236077 0.0000072068
C -1.2393189424 1.4064428097 0.0000009527
C -2.4585398474 0.6980627613 -0.0000119130
C -2.4584830245 -0.6980052848 -0.0000182990
C -1.2392726206 -1.4064393494 -0.0000121035
C 0.0000166810 -0.7186826023 0.0000005670
C 1.2392855074 -1.4064696461 0.0000073561
H 1.2470800358 -2.4919577916 0.0000018617
H -1.2470920207 -2.4919275393 -0.0000168975
H -3.3951566422 -1.2429180456 -0.0000277271
H -3.3952681112 1.2428765068 -0.0000168560
H -1.2469606339 2.4919363439 0.0000063915
H 1.2471333000 2.4919523490 0.0000239494
H 3.3951743890 1.2429028846 0.0000376679
H 3.3951863936 -1.2429173191 0.0000261673

Large diffs are not rendered by default.

Binary file not shown.
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
0 0 2

modelitzacio d'acetonitril com solvent CH3CN
ace.res
ACE INT 0
CHANGE NOMIT DU BEG
0.000000
1 DUMM DU M -5.298 3.870 -0.861 0.000000
2 DUMM DU M -5.925 3.000 -0.328 0.000000
3 DUMM DU M -5.298 -3.870 -0.861 0.000000
4 N1 YN M 0.314 1.215 -0.429 -0.489715
5 C2 YC M 1.223 0.576 -0.198 0.382240
6 C3 CT M 2.399 -0.250 0.102 -0.236648
7 H4 HC E 2.688 -0.801 -0.783 0.114711
8 H5 HC E 3.217 0.385 0.414 0.114711
9 H6 HC E 2.159 -0.945 0.896 0.114711

DONE
STOP




Binary file not shown.
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
Advanced Tutorial
=============================
Here we introduce some advanced usages of AutoSolvate. To learn the basic usages, please refer to the basic :doc:`tutorial` page.

Advanced Example 1: Custom Solvent
------------------------------------
Apart from the 5 common solvents contained in AutoSolvate, the user can use custom solvents found in databases or literature to build the solvated structure, as long as the `.frcmod` and `.off` files are available.

Here we show a simple use case. We are still going to work on the neutral naphthalene molecule used in the basic :doc:`tutorial`. However, this time we will put it in a custom solvent, dimethylsulfoxide (DMSO), which is not contained in AutoSolvate.


Step 1: Find custom solvent force field files
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Theoretically, we can generate GAFF force field for any solvent, and use that for our simulation.

However, it is ideal to use the solvent force fields that have been verified in publications and can reliably reproduce experimental results.

For example, if you want to simulate some solute in DMSO, you may want to look for existing Amber force field of DMSO. One online resource is the AMBER parameter database hosted by the Bryce Group at the University of Manchester: `<http://amber.manchester.ac.uk/>`_.

On the website, you may find some solvent boxes available, including DMSO. You will find two downloadable files for the DMSO solvent box:

#. **OFF**: The DMSO solvent box library file
#. **FRCMOD**: The DMSO force field modification file

You can download them and save as: `dmso.frcmod` and `dmso.off`.

Next, it is very important to find out the name of the solvent box file that will be recognized by AmberTools, and pass this name to AutoSolvate.

If you open the `dmso.off` file, you will see the first few lines as below:

.. code-block:: text
:linenos:
!!index array str
"d"
!entry.d.unit.atoms table str name str type int typex int resx int flags int seq int elmnt dbl chg
"S" "S" 0 1 131073 1 16 0.307524
"CT1" "CT" 0 1 131073 2 6 -0.262450
Notice that for a solvent box `OFF` file, the 2nd line is the **name** of the solvent box that can be recognized by AmberTool/tleap.
In this case, the name is `d`. That means, if one loads this `OFF` file and uses tleap to add the solvent box, the corresponding command should be::

>>> solventbox [solute_unit_name] d [box_size] [closeness]

So `d` is the solvent name that we should pass to AutoSolvate.

.. note::

If you don't like the original solvent box name given in the OFF file, feel free to change it to something else. For example, you can change the 2nd line
of dmso.off to "DMSO". Later you want to pass the new name, "DMSO" to AutoSolvate


Step 2: Run AutoSolvate with the custom solvent
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To generate the solvent box structure and MD prmtop files with custom solvent, the basic procedure is the same as the simple example about adding water (see :doc:`tutorial`).

The only difference is to provide 3 extra options:
#. solvent name (not the real name, but the name given in `OFF` file) with option `-s`
#. solvent `OFF` file path with option `-l`
#. solvent `FRCMOD` file path with option `-p`

Assuming that you have `naphthalene_neutral.xyz`, `dmso.off`, `dmso.frcmod` files all in the current
working directory, and the environment with AutoSolvate installed has been activated.
To add the DMSO solvent box to the neutral naphthalene molecule, you can simply run the following command::

>>> autosolvate boxgen -m naphthalene_neutral.xyz -s d -l dmso.off -p dmso.frcmod

This command should generate the solvated files: `d_solvated.inpcrd`, `d_solvated.prmtop`, and `d_solvated.pdb`.

Advanced Example 2: Automated recommendation of solvent-solute closeness
------------------------------------------------------------------------

The automated recommendation of solvent-solute closeness allows to generate initial structures where the closeness is closer to the equilibrated closeness. To demonstrate the automated recommendation of solvent-solute closeness run the following command::

>>> autosolvate boxgen -m naphthalene_neutral.xyz -s water -c 0 -u 1 -t automated

with the option `-t automated` the closeness will be automatically determined from the solvent identity.

Advanced Example 3: Freeze the solute molecule structure
--------------------------------------------------------

In certain situations, the user may want to add the solvation shell without changing the solute structure. This can be easily done turning on the "freeze solute" option in the command line or in the GUI interface. This will enable the `ibelly` option in Amber, freezing the solute molecule throughout all MD steps.

.. warning::

The option "freeze solute" will overwrite all the QM/MM options. QM/MM steps will be set to 0. QM/MM simulation will not run. The reason is that if solute is requested to be frozen, then there is no reason to calculate the QM gradients to update the solute structure. Running QM/MM will be a waste of time, because the expensive QM gradients will never be used.


To freeze the solute from command line, simply add the `-z` or `--freezesolute` option to your command. For example, for the naphthalene in water example shown in :ref:`Tutorial Step 2<tutstep2>`, the command to run MD with frozen solute is:

``autosolvate mdrun -f water_solvated -q 0 -u 1 -t 300 -p 1 -m 10000 -n 10000 -o 100 -s 100 -l 250 -z``

Here, although the user specified the number of steps for QM/MM minimization (`-o`), QMMM heat (`-s`) and QMMM equilibration (`-l`), these options will be ignored and set to 0 because the `-z` option is turned on. The above command is equivalent to

``autosolvate mdrun -f water_solvated -q 0 -u 1 -t 300 -p 1 -m 10000 -n 10000 -o 0 -s 0 -l 0 -z``

and

``autosolvate mdrun -f water_solvated -q 0 -u 1 -t 300 -p 1 -m 10000 -n 10000 -z``


To freeze the solute from the GUI interface, select "Yes" for the radial button of the "Freeze solute structure?" option in the *mdrun* GUI, as shown in the picture below.

.. image:: _images/advancedTutorial3_1.png
:width: 800




Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
18
-3.8580765971568428e+02 neutral napthalene
C 2.4397703245 -0.7099883961 0.0000206200
C 2.4397218526 0.7099981201 0.0000271508
C 1.2475921776 1.4061556571 0.0000203110
C -0.0000128759 0.7189947033 0.0000073141
C -1.2476290200 1.4061688746 0.0000008829
C -2.4397553974 0.7100487925 -0.0000117263
C -2.4397460082 -0.7099448889 -0.0000182422
C -1.2476288777 -1.4062156405 -0.0000121401
C 0.0000138676 -0.7190995078 0.0000006641
C 1.2476602178 -1.4062240260 0.0000074983
H 1.2448250471 -2.4927306634 0.0000020169
H -1.2447711187 -2.4927196649 -0.0000168971
H -3.3840069825 -1.2452230520 -0.0000277743
H -3.3839437525 1.2454155894 -0.0000167697
H -1.2448430780 2.4926825384 0.0000062499
H 1.2447883528 2.4926610011 0.0000242506
H 3.3839630326 1.2452901872 0.0000373621
H 3.3840333383 -1.2452476243 0.0000259290
Loading

0 comments on commit 570e1fd

Please sign in to comment.