DL POLY: Difference between revisions

From Alliance Doc
Jump to navigation Jump to search
No edit summary
m (Updated the scripts to use the last module from StdEnv/2023 environment.)
 
(20 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Draft}}
<languages />
<translate>


= General =
= General = <!--T:1-->


<!--T:2-->
* Project web site: [https://www.scd.stfc.ac.uk/Pages/DL_POLY.aspx DL_POLY4]
* Project web site: [https://www.scd.stfc.ac.uk/Pages/DL_POLY.aspx DL_POLY4]
* Documentation: [http://lammps.sandia.gov/doc/Manual.html Online Manual].
* Documentation: [ftp://ftp.dl.ac.uk/ccp5/DL_POLY/DL_POLY_4.0/DOCUMENTS/USRMAN4.pdf PDF manual].
* [https://www.jiscmail.ac.uk/cgi-bin/webadmin?A0=DLPOLY Mailing list.]
* [https://www.jiscmail.ac.uk/cgi-bin/webadmin?A0=DLPOLY Mailing list.]


DL_POLY is a general purpose classical molecular dynamics (MD) simulation software developed at Daresbury Laboratory by I.T. Todorov and W. Smith.
<!--T:3-->
DL_POLY is a general purpose classical molecular dynamics (MD) simulation software. It provides scalable performance from a single processor workstation to a high performance parallel computer. DL_POLY_4 offers fully parallel I/O as well as a NetCDF alternative to the default ASCII trajectory file.


Currently, only one version of the DL_POLY software is available under an STFC licence, DL_POLY_4, and with support provisioned to the UK's academia only. The former DL_POLY_2 version (authored by W. Smith, T.R. Forester and I.T. Todorov) is now transformed into [http://www.ccp5.ac.uk/DL_POLY_C/ DL_POLY_Classic] and available as open source under the [https://opensource.org/licenses/bsd-license.php BSD] at [http://ccpforge.cse.rl.ac.uk/gf/project/dl_poly_classic/ CCPForge].
<!--T:4-->
For more on the capabilities, design, and history of DL_POLY, please see the [https://www.scd.stfc.ac.uk/Pages/DL_POLY.aspx project's web site].


DL_POLY_4 general design provides scalable performance from a single processor workstation to a high performance parallel computer. It is supplied in source form under license and can be compiled as a serial application code, using only a Fortran90 compiler, or as a parallel application code, provided an MPI2 instrumentation is available on the parallel machine. DL_POLY_4 offers fully parallel I/O as well as a netCDF alternative (HDF5 library dependence) to the default ASCII trajectory file.
= License limitations = <!--T:5-->


= License limitations =
<!--T:6-->
'''DL_POLY''' is now [https://gitlab.com/DL%20POLY%20Classic/dl%20poly open source] and it does not require registration. A new module '''dl_poly4/5.1.0''' is already installed under '''StdEnv/2023''' and it is accessible for all users. However, if you would like to use the previous versions ('''dl_poly4/4.10.0''' and/or '''dl_poly4/4.08'''), you should contact [[Technical_support | support]] and ask to be added to the POSIX group that controls access to DL_POLY4. There is no need to register on DL_POLY website.


To get access to DL_POLY on Compute Canada clusters, users need first to register at http://www.scd.stfc.ac.uk/SCD/40526.aspx and send proof of registration by forwarding the confirmation email to [[Technical_support | support]].  
= Modules = <!--T:8-->
To see which versions of DL_POLY are installed on our systems, run <code>module spider dl_poly4</code>. See [[Using modules]] for more about <code>module</code> subcommands.


The confirmation email should include:<br />
<!--T:9-->
To load the version '''5.x''', use:


::Dear xxxx,<br />
<!--T:40-->
::You have registered for a free copy of the DL_POLY_4 program and thus<br />
<code>module load StdEnv/2023  intel/2023.2.1  openmpi/4.1.5 dl_poly4/5.1.0</code>
::accepted the terms and conditions of the DL_POLY_4 ACADEMIC LICENCE!<br />
::You have provided the following details at registration:<br />
::Department: xxx<br />
::Institution: xxx<br />
::Address: xxx<br />
::Town/City: xxx<br />
::Post Code: xxx<br />
::Country: xxx<br />
::Science Domain: xxx<br />


= Modules =
<!--T:10-->
To see which versions of DL_POLY are installed on Compute Canada systems, run <code>module spider dl_poly4</code>. See [[Using modules]] for more about <code>module</code> subcommands.
To load the previous version 4.10.0, use:


On of the options to load the module is:
<!--T:41-->
<code>module load StdEnv/2023 intel/2020.1.217  openmpi/4.0.3 dl_poly4/4.10.0</code>


<code>module load nixpkgs/16.09  intel/2018.3  openmpi/3.1.2 dl_poly4/4.08</code>
<!--T:42-->
Note that this version requires to be added to a POSIX group as explained above in [[#License limitations | License limitations]].


'''Note:''' The Java GUI interface is not supported in this module.
<!--T:11-->
We do not currently provide a module for the Java GUI interface.


= Getting started =
= Getting started = <!--T:12-->


* [ftp://ftp.dl.ac.uk/ccp5/DL_POLY/DL_POLY_4.0/TUTORIAL/ DL_POLY Tutorial and Exercises]
<!--T:13-->
* [ftp://ftp.dl.ac.uk/ccp5/DL_POLY/DL_POLY_4.0/TUTORIAL/ DL_POLY tutorial and exercises]
* [ftp://ftp.dl.ac.uk/ccp5/DL_POLY/DL_POLY_4.0/DATA/ DL_POLY4 examples]
* [ftp://ftp.dl.ac.uk/ccp5/DL_POLY/DL_POLY_4.0/DATA/ DL_POLY4 examples]
* [https://www.scd.stfc.ac.uk/Pages/DL_POLY-FAQs.aspx DL_POLY Frequently Asked Questions]
* [https://www.scd.stfc.ac.uk/Pages/DL_POLY-FAQs.aspx DL_POLY FAQs]
* [https://www.scd.stfc.ac.uk/Pages/DL_Software-Code-of-Conduct.aspx DL_Software User Community]
* [https://www.scd.stfc.ac.uk/Pages/DL_Software-Code-of-Conduct.aspx DL_Software User Community]
* [https://www.scd.stfc.ac.uk/Pages/DL_POLY-Useful-Resources.aspx Useful Resources for DL_POLY Users]
* [https://www.scd.stfc.ac.uk/Pages/DL_POLY-Useful-Resources.aspx Useful Resources for DL_POLY Users]


= Scripts and examples =
= Scripts and examples = <!--T:14-->


The input files (CONTROL and FIELD) were take from the example TEST01 that can be downloaded from the page of [ftp://ftp.dl.ac.uk/ccp5/DL_POLY/DL_POLY_4.0/DATA/ DL_POLY examples].
<!--T:15-->
The input files shown below (CONTROL and FIELD) were taken from example TEST01 that can be downloaded from the page of [ftp://ftp.dl.ac.uk/ccp5/DL_POLY/DL_POLY_4.0/DATA/ DL_POLY examples].


To start a simulation, one need to have at least 3 files:
<!--T:16-->
To start a simulation, one must have at least three files:


* '''CONFIG''': simulation box (atomic coordinates).
<!--T:17-->
* '''FIELD''': force field parameters.
* '''CONFIG''': simulation box (atomic coordinates)
* '''CONTROL''': simulation parameters (time step, number of MD steps, simulation ensemble, ...etc).
* '''FIELD''': force field parameters
* '''CONTROL''': simulation parameters (time step, number of MD steps, simulation ensemble, ...etc.)


<!--T:20-->
<tabs>
<tabs>
<tab name="CONTROL">
<tab name="CONTROL">
Line 66: Line 73:
SODIUM CHLORIDE WITH (27000 IONS)
SODIUM CHLORIDE WITH (27000 IONS)


<!--T:21-->
restart scale
restart scale
temperature          500.0
temperature          500.0
Line 72: Line 80:
timestep              0.001
timestep              0.001


<!--T:22-->
cutoff                12.0
cutoff                12.0
rvdw                  12.0
rvdw                  12.0
ewald precision      1d-6   
ewald precision      1d-6   


<!--T:23-->
ensemble nvt berendsen 0.01
ensemble nvt berendsen 0.01


<!--T:24-->
print every          2
print every          2
stats every          2
stats every          2
Line 84: Line 95:
close time            10
close time            10


<!--T:25-->
finish
finish
}}
}}
Line 115: Line 127:
#!/bin/bash
#!/bin/bash


<!--T:26-->
#SBATCH --account=def-someuser
#SBATCH --account=def-someuser
#SBATCH --ntasks=1
#SBATCH --ntasks=1
Line 120: Line 133:
#SBATCH --time=0-00:30          # time (DD-HH:MM).
#SBATCH --time=0-00:30          # time (DD-HH:MM).


<!--T:27-->
# Load the module:
# Load the module:


module load nixpkgs/16.09 intel/2018.3 openmpi/3.1.2 dl_poly4/4.08
<!--T:28-->
module load StdEnv/2023 
module load intel/2023.2.openmpi/4.1.5 dl_poly4/5.1.0


<!--T:29-->
echo "Starting run at: `date`"
echo "Starting run at: `date`"


<!--T:30-->
dlp_exec=DLPOLY.Z
dlp_exec=DLPOLY.Z


<!--T:31-->
${dlp_exec}
${dlp_exec}


<!--T:32-->
echo "Program finished with exit code $? at: `date`"
echo "Program finished with exit code $? at: `date`"
}}
}}
Line 140: Line 160:
#!/bin/bash
#!/bin/bash


<!--T:33-->
#SBATCH --account=def-someuser
#SBATCH --account=def-someuser
#SBATCH --nodes=1
#SBATCH --nodes=1
Line 146: Line 167:
#SBATCH --time=0-00:30          # time (DD-HH:MM).
#SBATCH --time=0-00:30          # time (DD-HH:MM).


<!--T:34-->
# Load the module:
# Load the module:


module load nixpkgs/16.09 intel/2018.3 openmpi/3.1.2 dl_poly4/4.08
<!--T:35-->
module load StdEnv/2023 
module load intel/2023.2.openmpi/4.1.5 dl_poly4/5.1.0


<!--T:36-->
echo "Starting run at: `date`"
echo "Starting run at: `date`"


<!--T:37-->
dlp_exec=DLPOLY.Z
dlp_exec=DLPOLY.Z


<!--T:38-->
srun ${dlp_exec}
srun ${dlp_exec}


<!--T:39-->
echo "Program finished with exit code $? at: `date`"
echo "Program finished with exit code $? at: `date`"
}}
}}
Line 161: Line 189:
</tabs>
</tabs>


= Related software =
= Related software = <!--T:18-->


* VMD
<!--T:19-->
* [[VMD]]
* [[LAMMPS]]
* [[LAMMPS]]
</translate>

Latest revision as of 14:42, 3 April 2024

Other languages:

General[edit]

DL_POLY is a general purpose classical molecular dynamics (MD) simulation software. It provides scalable performance from a single processor workstation to a high performance parallel computer. DL_POLY_4 offers fully parallel I/O as well as a NetCDF alternative to the default ASCII trajectory file.

For more on the capabilities, design, and history of DL_POLY, please see the project's web site.

License limitations[edit]

DL_POLY is now open source and it does not require registration. A new module dl_poly4/5.1.0 is already installed under StdEnv/2023 and it is accessible for all users. However, if you would like to use the previous versions (dl_poly4/4.10.0 and/or dl_poly4/4.08), you should contact support and ask to be added to the POSIX group that controls access to DL_POLY4. There is no need to register on DL_POLY website.

Modules[edit]

To see which versions of DL_POLY are installed on our systems, run module spider dl_poly4. See Using modules for more about module subcommands.

To load the version 5.x, use:

module load StdEnv/2023 intel/2023.2.1 openmpi/4.1.5 dl_poly4/5.1.0

To load the previous version 4.10.0, use:

module load StdEnv/2023 intel/2020.1.217 openmpi/4.0.3 dl_poly4/4.10.0

Note that this version requires to be added to a POSIX group as explained above in License limitations.

We do not currently provide a module for the Java GUI interface.

Getting started[edit]

Scripts and examples[edit]

The input files shown below (CONTROL and FIELD) were taken from example TEST01 that can be downloaded from the page of DL_POLY examples.

To start a simulation, one must have at least three files:

  • CONFIG: simulation box (atomic coordinates)
  • FIELD: force field parameters
  • CONTROL: simulation parameters (time step, number of MD steps, simulation ensemble, ...etc.)


File : CONTROL

SODIUM CHLORIDE WITH (27000 IONS)

restart scale
temperature           500.0
equilibration steps   20
steps                 20
timestep              0.001

cutoff                12.0
rvdw                  12.0
ewald precision       1d-6  

ensemble nvt berendsen 0.01

print every           2
stats every           2
collect
job time              100
close time            10

finish


File : FIELD

SODIUM CHLORIDE WITH EWALD SUM (27000 IONS)
units internal
molecular types 1
SODIUM CHLORIDE
nummols 27
atoms 1000
Na+          22.9898         1.0  500
Cl-           35.453        -1.0  500
finish
vdw    3 
Na+     Na+     bhm      2544.35      3.1545      2.3400   1.0117e+4   4.8177e+3
Na+     Cl-     bhm      2035.48      3.1545      2.7550   6.7448e+4   8.3708e+4
Cl-     Cl-     bhm      1526.61      3.1545      3.1700   6.9857e+5   1.4032e+6
close


File : run_serial_dlp.sh

#!/bin/bash

#SBATCH --account=def-someuser
#SBATCH --ntasks=1
#SBATCH --mem-per-cpu=2500M      # memory; default unit is megabytes.
#SBATCH --time=0-00:30           # time (DD-HH:MM).

# Load the module:

module load StdEnv/2023  
module load intel/2023.2.1  openmpi/4.1.5 dl_poly4/5.1.0

echo "Starting run at: `date`"

dlp_exec=DLPOLY.Z

${dlp_exec}

echo "Program finished with exit code $? at: `date`"


File : run_mpi_dlp.sh

#!/bin/bash

#SBATCH --account=def-someuser
#SBATCH --nodes=1
#SBATCH --ntasks-per-node=4
#SBATCH --mem-per-cpu=2500M      # memory; default unit is megabytes.
#SBATCH --time=0-00:30           # time (DD-HH:MM).

# Load the module:

module load StdEnv/2023  
module load intel/2023.2.1  openmpi/4.1.5 dl_poly4/5.1.0

echo "Starting run at: `date`"

dlp_exec=DLPOLY.Z

srun ${dlp_exec}

echo "Program finished with exit code $? at: `date`"


Related software[edit]