dlpoly-py

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

please report issues in the gitlab tracker

available in the matrix room

Metadata

Release files for dlpoly-py 0.4.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for dlpoly-py 0.4.1
File	Size	Uploaded	Provenance
dlpoly-py-0.4.1.tar.gz	10.4 MB	Jan 10, 2024	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for dlpoly-py 0.4.1
File	Interpreter	ABI	Platform	Reset
dlpoly_py-0.4.1-py3-none-any.whl 37.9 kB Jan 10, 2024 Without provenance	Python 3	none	any	Details

Total release size: 10.4 MB

Release files / dlpoly-py-0.4.1.tar.gz

Download URL	dlpoly-py-0.4.1.tar.gz
Size	10.4 MB
Tags	Source
SHA-256 checksum How to use checksums	`24148eb637549b5dc6b4047332042f99a6dc661fcde07a8da780e6ef7e27f3cb`
BLAKE2b-256 checksum How to use checksums	`b6aaf10791b6f81470eec73833f07bb8bf82a6b8f2e10f1255505699db720319`
Upload date	Jan 10, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.11.0`

Release files / dlpoly_py-0.4.1-py3-none-any.whl

Download URL	dlpoly_py-0.4.1-py3-none-any.whl
Size	37.9 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`f4a40c25323b0542966eae2e2741e900aac75caaf5a3e0f1f817cc19eb71f946`
BLAKE2b-256 checksum How to use checksums	`e8e591476058dc6da7884bd5437510a00326bd980e74c63eaa87c0254ce84f4a`
Upload date	Jan 10, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.11.0`

Security for dlpoly-py 0.4.1

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.