Skip to content

Commit

Permalink
Merge pull request #8 from ACBC19/test
Browse files Browse the repository at this point in the history
V.14-08
  • Loading branch information
SIRAHFF authored Aug 14, 2023
2 parents c77b992 + ec93744 commit ec662b1
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 42 deletions.
54 changes: 12 additions & 42 deletions docs/source/AMBER/Tutorial-1.rst
Original file line number Diff line number Diff line change
@@ -1,50 +1,11 @@
This tutorial shows how to perform a coarse grained (CG) simulation of a double stranded DNA using the Generalized Born model for implicit solvent (GB) and the SIRAH force field. The main references
for this tutorial are: `Dans et al. SIRAH DNA <https://pubs.acs.org/doi/abs/10.1021/ct900653p>`_ (latest parameters are those reported in: `Darré et al. WAT4?) <https://pubs.acs.org/doi/abs/10.1021/ct100379f>`_, `Machado et al. SIRAH Tools <https://academic.oup.com/bioinformatics/article/32/10/1568/1743152>`_. We strongly advise you to read these articles before starting the tutorial.

Required Software
__________________

.. _vmd: www.ks.uiuc.edu/Research/vmd

AMBER 16 and AMBER Tools 16 or later versions properly installed and running in your computer. The molecular visualization program VMD 1.9.3 or later version (`freely available download <vmd>`_).


Prior knowledge
_______________

How to perform a standard atomistic molecular dynamic simulation with AMBER and basic usage of
VMD. If you are not familiar with DNA stuff we strongly recommend you to first perform the `AMBER
tutorial on DNA <http://ambermd.org/tutorials/basic/tutorial1>`_.

Download and set up SIRAH Force Field
______________________________________

Download the file ``sirah_[version].amber.tgz`` from www.sirahff.com and uncompress it into your
working directory. Notice: ``[version]`` should be replaced with the actual package version e.g.: x2_18-09

.. code-block:: bash
$ tar -xzvf sirah_[version].amber.tgz
You will get a folder ``sirah_[version].amber/`` containing the force field definition, the SIRAH Tools in
``sirah_[version].amber/tools/``, molecular structures to build up systems in ``sirah_[version].amber/PDB/``,
frequently asked questions in ``sirah_[version].amber/tutorial/SIRAH_FAQs.pdf`` and the required
material to perform the tutorial in ``sirah_[version].amber/tutorial/1/``

Make a new folder for this tutorial in your working directory:

.. code-block:: bash
$ mkdir tutorial1; cd tutorial1
Create the following symbolic link in the folder tutorial1:

.. code-block:: bash
ln -s ../sirah_[version].amber sirah.amber
.. important::

check :ref:`install <Download amber>` section for download and set up details before to start this tutorial

1. Build GC representations
1. Build CG representations
________________________________________________________________________

Map the atomistic structure of a 20-mer DNA to its CG representation:
Expand Down Expand Up @@ -149,19 +110,28 @@ contains the definition of Watson-Crick restraints for the capping base pairs of
$ sander -O -i ../sirah.amber/tutorial/1/SANDER/em_GB.in -p ../dna_cg.prmtop -c ../dna_cg.ncrst -o dna_cg_em.out -r dna_cg_em.ncrst &
.. note::

- ``sander``: The AMBER program for molecular dynamics simulations.
- ``-i``: Input file.
- ``-o``: Output file.
- ``-p``: Parameter/topology file.
- ``-c``: Coordinate file.
- ``-r``: Restart file.
- ``-x``: Trajectory file.

**Equilibration:**

.. code-block:: bash
$ sander -O -i ../sirah.amber/tutorial/1/SANDER/md_GB.in -p ../dna_cg.prmtop -c dna_cg_eq.ncrst -o dna_cg_md.out -r dna_cg_md.ncrst
**Production (100ns):**

.. code-block:: bash
sander -O -i ../sirah.amber/tutorial/1/SANDER/md_GB.in -p ../dna_cg.prmtop -c dna_cg_eq.ncrst -o dna_cg_md.out -r dna_cg_md.ncrst -x dna_cg_md.nc &
.. note::

Expand Down
41 changes: 41 additions & 0 deletions docs/source/AMBER/installation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
Required Software
__________________

.. _vmd: www.ks.uiuc.edu/Research/vmd

AMBER 16 and AMBER Tools 16 or later versions properly installed and running in your computer. The molecular visualization program VMD 1.9.3 or later version (`freely available download <vmd>`_).


Prior knowledge
_______________

How to perform a standard atomistic molecular dynamic simulation with AMBER and basic usage of
VMD. If you are not familiar with DNA stuff we strongly recommend you to first perform the `AMBER
tutorial on DNA <http://ambermd.org/tutorials/basic/tutorial1>`_.

Download and set up SIRAH Force Field
______________________________________

Download the file ``sirah_[version].amber.tgz`` from www.sirahff.com and uncompress it into your
working directory. Notice: ``[version]`` should be replaced with the actual package version e.g.: x2_18-09

.. code-block:: bash
$ tar -xzvf sirah_[version].amber.tgz
You will get a folder ``sirah_[version].amber/`` containing the force field definition, the SIRAH Tools in
``sirah_[version].amber/tools/``, molecular structures to build up systems in ``sirah_[version].amber/PDB/``,
frequently asked questions in ``sirah_[version].amber/tutorial/SIRAH_FAQs.pdf`` and the required
material to perform the tutorial in ``sirah_[version].amber/tutorial/1/``

Make a new folder for this tutorial in your working directory:

.. code-block:: bash
$ mkdir tutorial1; cd tutorial1
Create the following symbolic link in the folder tutorial1:

.. code-block:: bash
ln -s ../sirah_[version].amber sirah.amber
7 changes: 7 additions & 0 deletions docs/source/Tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@ AMBER

.. _AMBER:

Download and pre-requisites
----------------------------

.. _Download amber:

.. include:: /AMBER/installation.rst

Simulation of a coarse grained DNA molecule in implicit solvent
----------------------------------------------------------------------------

Expand Down

0 comments on commit ec662b1

Please sign in to comment.