Skip to main content

Schema-based tools and interfaces for Quantum Espresso data

Project description

The qeschema package provides tools for converting XML data produced by the Quantum ESPRESSO suite of codes (ESPRESSO: opEn-Source Package for Research in Electronic Structure, Simulation and Optimization).

Requirements

  • Python 3.7+

  • xmlschema (Python library for processing XML Schema based documents)

Installation

You can install the library with pip in a Python 3.7+ environment:

pip install qeschema

If you need HDF5 utilities and/or the YAML format, install the extra features using the appropriate command from these alternatives:

pip install qeschema[HDF5]
pip install qeschema[YAML]
pip install qeschema[HDF5,YAML]

Usage

Define you data document using:

>>> import qeschema
>>> pw_document = qeschema.PwDocument()

and then read XML data from a file processed by the corresponding application of Quantum ESPRESSO suite:

>>> pw_document.read("tests/examples/pw/Si.xml")

Loaded data can be decoded to Python data dictionary or written to JSON or YAML formats:

>>> xml_data = pw_document.to_dict()
>>> json_data = pw_document.to_json()

Authors

  • Davide Brunato

  • Pietro Delugas

  • Giovanni Borghi

  • Alexandr Fonari

License

This software is distributed under the terms of the MIT License. See the file ‘LICENSE’ in the root directory of the present distribution, or http://opensource.org/licenses/MIT.

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

qeschema-1.5.1.tar.gz (199.5 kB view details)

Uploaded Source

Built Distribution

qeschema-1.5.1-py3-none-any.whl (160.5 kB view details)

Uploaded Python 3

File details

Details for the file qeschema-1.5.1.tar.gz.

File metadata

  • Download URL: qeschema-1.5.1.tar.gz
  • Upload date:
  • Size: 199.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.12

File hashes

Hashes for qeschema-1.5.1.tar.gz
Algorithm Hash digest
SHA256 4b017e7cf6e5dd6b446e32ed2991fd266545547ddf3d3fa212c235b81026066b
MD5 7c79c627184aa1e455eaea37fd9de7b1
BLAKE2b-256 b7e10d814af6702e73ab66443cccab466de90e15f1cdd0d05d2ea2f083a7a412

See more details on using hashes here.

File details

Details for the file qeschema-1.5.1-py3-none-any.whl.

File metadata

  • Download URL: qeschema-1.5.1-py3-none-any.whl
  • Upload date:
  • Size: 160.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.12

File hashes

Hashes for qeschema-1.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8198227a2ce3a997e9c4f0272a04e84762e7a091ac071e43ad8f552c42260f65
MD5 791790a1a7519a8536017f6e07f363fc
BLAKE2b-256 63a924359787f4ee3de944d093fbb02b6bc7a8e74ad7b40bba8f4382f2ae926d

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