Skip to main content

env_suite

env_suite is a package for generating input and submission files for vasp calculations

Installation via pip

Install env_suite using pip (if using a shared machine, add the --user argument after install)

pip install env_suite

Updating

Update the code using pip (if using a shared machine, add the --user argument after install)

pip install env_suite --upgrade

Installation with pip editable install

Only do this if you are developing (i.e. changing) the code.

Clone a copy of this repository, preferably while within a directory called git

mkdir -p git; cd git
git clone https://gitlab.com/chilton-group/env_suite

Navigate to the package directory

cd env_suite

and install the package in editable mode (if using a shared machine, add the --user argument after install)

pip install -e .

When you're done developing (i.e. your changes have been merged to the master), or if you just want to use the current release version of the package, uninstall using pip

pip uninstall env_suite

and follow the Installation via pip instructions above.

Usage

The env_suite command line interface can be invoked with

env_suite -h

which prints a list of available subprograms.

Alternatively, the individual submodules can be imported into a python program or script as per usual.

Building a .whl file (Advanced)

Only do this if you are told to.

To build a copy of the vasp_suite .whl file, move to the package directory.

Now run

./build_binaries.sh

Then install the .whl file with pip (if using a shared machine, add the --user argument after install)

pip install dist/*.whl

Documentation

The documentation for this package is hosted by gitlab, and is automatically generated whenever new code is committed to the main branch. The automatic generation of this documentation relies on a common layout for comments and docstrings within the code, see contributing for more information.

Development

Before making changes to this repository, please follow the steps outlined in the Chilton group wiki.

Bugs

If you believe you have a bug, please check that you are using the most up to date version of the code.

If that does not fix the problem, please create an issue on GitLab detailing the following:

  • The commands you entered
  • The error message

Remember to simplify the problem as much as possible in order to provide a minimum working example, e.g. an example for a small molecule rather than one with 100000 atoms.

Then, look at the code, try and figure out what you think is wrong if possible, and include this in your issue.

Metadata

Release files for env-suite 0.12.0

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

Source distribution (sdist)

Source distribution for env-suite 0.12.0
File Size Uploaded Provenance Actions
env_suite-0.12.0.tar.gz 54.9 kB Without provenance Details for env_suite-0.12.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for env-suite 0.12.0
File Interpreter ABI Platform Actions
env_suite-0.12.0-py3-none-any.whl Python 3 none any Details for env_suite-0.12.0-py3-none-any.whl

Total release size: 112.7 kB

Release files / env_suite-0.12.0.tar.gz

Download URL env_suite-0.12.0.tar.gz
Size 54.9 kB
Tags Source
SHA-256 checksum
How to use checksums
9d52004eda48ea79374c0709fa0028111b3d77533a555b53597a4fbb9b06a6c5
BLAKE2b-256 checksum
How to use checksums
c623375013cc6737a7b29aef6a744d04c2cd7c91e4b4b4209d7e7a15fccfebd4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 pkginfo/1.13.3 readme-renderer/46.0 requests/2.34.2 requests-toolbelt/1.0.0 urllib3/2.8.0 tqdm/4.70.1 importlib-metadata/9.0.1 keyring/25.7.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.10.22

Release files / env_suite-0.12.0-py3-none-any.whl

Download URL env_suite-0.12.0-py3-none-any.whl
Size 57.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cc99fb588574ebe7457047a18a935b7ec8651745478c191799ca0339f1c21966
BLAKE2b-256 checksum
How to use checksums
fa0b40af986e061b349119ae1f01efa0009939bc356548da887a52883e7355a3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 pkginfo/1.13.3 readme-renderer/46.0 requests/2.34.2 requests-toolbelt/1.0.0 urllib3/2.8.0 tqdm/4.70.1 importlib-metadata/9.0.1 keyring/25.7.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.10.22

Security for env-suite 0.12.0

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page