Skip to main content

dlpoly4 python module for file manipulation

Project description

https://badge.fury.io/py/dlpoly-py.svg https://img.shields.io/conda/vn/conda-forge/dlpoly-py.svg

dlpoly-py package contains tools to read input and output for DL_POLY it can also produce inputs and be mixed with other python packages like ASE, MDAnalysis, MDAnse or pymatgen

install

You need Python 3.6 or later to run dlpoly-py. You can have multiple Python versions (2.x and 3.x) installed on the same system without problems.

To install Python 3 for different Linux flavors, macOS and Windows, packages are available at https://www.python.org/getit

Using pip

pip is the most popular tool for installing Python packages, and the one included with modern versions of Python.

dlpoly-py can be installed with pip

pip install dlpoly-py

Note:

Depending on your Python installation, you may need to use pip3 instead of pip.

pip3 install dlpoly-py

Depending on your configuration, you may have to run pip like this:

python3 -m pip install dlpoly-py

Using pip (GIT Support)

pip currently supports cloning over git

pip install git+https://gitlab.com/drFaustroll/dlpoly-py.git

For more information and examples, see the pip install reference.

Using a virtual environment

# create virtual env
virtualenv3 venv/dlpoly
source venv/dlpoly/bin/activate
pip3 install dlpoly-py

Using conda

conda is the package management tool for Anaconda Python installations.

Installing dlpoly-py from the conda-forge channel can be achieved by adding conda-forge to your channels with:

conda config --add channels conda-forge

Once the conda-forge channel has been enabled, dlpoly-py can be installed with:

conda install dlpoly-py

It is possible to list all of the versions of dlpoly-py available on your platform with:

conda search dlpoly-py --channel conda-forge

usage

Examples can be found in https://gitlab.com/drFaustroll/dlpoly-py/-/tree/devel/examples

sime run using Ar data from above folder.

from dlpoly import DLPoly

dlp="/home/drFaustroll/playground/dlpoly/dl-poly-alin/build-yaml/bin/DLPOLY.Z"

dlPoly = DLPoly(control="Ar.control", config="Ar.config",
                field="Ar.field", workdir="argon")
dlPoly.run(executable=dlp,numProcs = 4)

# change temperature and rerun, from previous termination
dlPoly = DLPoly(control="Ar.control", config="argon/REVCON", destconfig="Ar.config",
             field="Ar.field", workdir="argon-T310")
dlPoly.control.temp = 310.0
dlPoly.run(executable=dlp,numProcs = 4)

alternatively you can set the environment variable DLP_EXE to point to DL_POLY_4 executable and remove the executable parameter from run.

export DLP_EXE="/home/drFaustroll/playground/dlpoly/dl-poly-alin/build-yaml/bin/DLPOLY.Z"
from dlpoly import DLPoly

dlPoly = DLPoly(control="Ar.control", config="Ar.config",
                field="Ar.field", workdir="argon")
dlPoly.run(numProcs = 4)

# change temperature and rerun, from previous termination
dlPoly = DLPoly(control="Ar.control", config="argon/REVCON", destconfig="Ar.config",
             field="Ar.field", workdir="argon-T310")
dlPoly.control.temp = 310.0
dlPoly.run(numProcs = 4)

authors

  • Alin M Elena, Daresbury Laboratory, UK

  • Jacob Wilkins, University of Oxford, UK

contact

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dlpoly-py-0.4.1.tar.gz (10.4 MB view details)

Uploaded Source

Built Distribution

dlpoly_py-0.4.1-py3-none-any.whl (37.9 kB view details)

Uploaded Python 3

File details

Details for the file dlpoly-py-0.4.1.tar.gz.

File metadata

  • Download URL: dlpoly-py-0.4.1.tar.gz
  • Upload date:
  • Size: 10.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for dlpoly-py-0.4.1.tar.gz
Algorithm Hash digest
SHA256 24148eb637549b5dc6b4047332042f99a6dc661fcde07a8da780e6ef7e27f3cb
MD5 3861934bce240a7d316b74ff9636a718
BLAKE2b-256 b6aaf10791b6f81470eec73833f07bb8bf82a6b8f2e10f1255505699db720319

See more details on using hashes here.

File details

Details for the file dlpoly_py-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: dlpoly_py-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 37.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for dlpoly_py-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f4a40c25323b0542966eae2e2741e900aac75caaf5a3e0f1f817cc19eb71f946
MD5 de41d127502ce0f7dcf7e5d34a43faf5
BLAKE2b-256 e8e591476058dc6da7884bd5437510a00326bd980e74c63eaa87c0254ce84f4a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page