Skip to main content

Python API for the Quantum Espresso software

Project description

Documentation

ase-espresso provides a Python interface compatible with Atomic Simulation Environment (ASE) for managing calculations with the Quantum Espresso code.

This is a fork from vossjo that offers a lot of improvements over the original version, the most important ones include:

  • the files were restructured into a python package

  • a setup.py file was introduced to allow installation through pip or setuptools

  • configuration for the documentation is provided through sphinx and a lot of docstrings were updated

  • the site.cfg is obsolete now, and no additional configuration is required, the functionality is replaced by a new SiteConfig class that dynamically gathers information about the execution environment

  • the old espresso class is now split into two: Espresso preserving the standard functionality and iEspresso responsible for dynamic/interactive jobs with a custom version of pw.x

  • changes were made to establish python 3.x compatibility

  • the Espresso class were restructured according to ase guidelines regarding calculator objects to support full compatibility with ase

  • most of the system calls are now handled by pexpect and subprocess instead of the os.system, os.popen(), os.popen2(), os.popen3()

  • tests were added

  • code style and readability were improved

Installation

Dependencies

The recommended installation method is with pip. The current version can be installed directly from github:

pip install https://github.com/lmmentel/ase-espresso/archive/master.zip

or cloned first

git clone https://github.com/lmmentel/ase-espresso.git

and installed via

pip install ./ase-espresso

Documentation

The documentation is hosted on ase-espresso.readthedocs.io.

You can also generate the documentation locally using sphinx by going to the docs directory and typing:

make html

The built documentation can be viewed in a any browser

firefox build/html/index.html

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

aseqe-0.3.4.tar.gz (57.1 kB view details)

Uploaded Source

Built Distribution

aseqe-0.3.4-py3-none-any.whl (56.1 kB view details)

Uploaded Python 3

File details

Details for the file aseqe-0.3.4.tar.gz.

File metadata

  • Download URL: aseqe-0.3.4.tar.gz
  • Upload date:
  • Size: 57.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.9.1

File hashes

Hashes for aseqe-0.3.4.tar.gz
Algorithm Hash digest
SHA256 771b89be18d10c404685cce2713d58fb719eb3b29ff6b395234be18c0422a0b5
MD5 fc5b1c777017a4ff20fa5bef5198ba50
BLAKE2b-256 e71f0371ee63acb30cb55d29bd24654a7a3ca848041d7fc4ac17fc4a10576d2d

See more details on using hashes here.

File details

Details for the file aseqe-0.3.4-py3-none-any.whl.

File metadata

  • Download URL: aseqe-0.3.4-py3-none-any.whl
  • Upload date:
  • Size: 56.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.9.1

File hashes

Hashes for aseqe-0.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 029c25d6ee5bb7a1014fc6ce1a046b2406173d1ddb8ae5f91464ea5e13b68a1a
MD5 64ea44f2d0b462f0e66e4c805de02247
BLAKE2b-256 d67e6f315e909fb5a1113e16504e361c30faf580c830fb70fdd6ae8916de1d48

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