Skip to main content

Set of tools for TREXIO files

Project description

TREXIO tools

PyPI version

Set of tools for TREXIO files.

Requirements

  • python3 (>=3.6)
  • trexio (>=1.0.0) [Python API]
  • numpy (>=1.17.3)
  • resultsFile [for GAMESS/GAU$$IAN conversion]
  • docopt [for CLI]
  • pyscf [only if you use the pyscf->trexio converter]

Installation

Installation via PyPI, periodically updated

pip install trexio-tools

Installation from source code

  1. Clone the repository
  • git clone https://github.com/TREX-CoE/trexio_tools.git
  1. Create an isolated virtual environment, for example using
  • python3 -m venv trexio_tools
  1. Activate the previously created environment, for example using
  • source trexio_tools/bin/activate
  1. Install the Python packages that are required for trexio-tools to work
  • pip install -r requirements.txt
  1. Install trexio-tools via pip (also works in --editable mode)
  • pip install .

Instructions for users

After installation, trexio-tools provides an entry point, which can be accessed via CLI:

trexio --help

This will list all currently supported command line arguments. For example,

trexio convert-from -t gamess -i data/GAMESS_CAS.log -b hdf5 trexio_cas.hdf5

converts data from the GAMESS_CAS.log output file of the GAMESS code (note also -t gamess argument) into the TREXIO file called trexio_cas.hdf5 using -b hdf5 back end of TREXIO.

and,

trexio convert-from -t orca -i data/h2o.json -b hdf5 trexio_orca.hdf5

Note that since ORCA AOs and MOs are in spherical coordinates, one needs to convert these to cartesian to be able to use trexio functions.

trexio convert-to -t cartesian -o trexio_orca_cart.hdf5 trexio_orca.hdf5

converts data from the h2o.json output file of the ORCA code into the TREXIO file called trexio_orca.hdf5 using -b hdf5 back end of TREXIO followed by converting the spherical AOs and MOs to cartesian coordinates.

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

trexio-tools-0.7.0.tar.gz (42.1 kB view details)

Uploaded Source

Built Distribution

trexio_tools-0.7.0-py3-none-any.whl (48.7 kB view details)

Uploaded Python 3

File details

Details for the file trexio-tools-0.7.0.tar.gz.

File metadata

  • Download URL: trexio-tools-0.7.0.tar.gz
  • Upload date:
  • Size: 42.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for trexio-tools-0.7.0.tar.gz
Algorithm Hash digest
SHA256 7db25e02974a99c8c0be372bdb20cce390dfaa4404c30f0bdf71c7d86641c9b8
MD5 4c7a4f51c32d477b21174433868a2320
BLAKE2b-256 1bd30c197e2c3735011c4e0ebbc73ecc5d935fd1a24d4441be0b9832689f78b7

See more details on using hashes here.

File details

Details for the file trexio_tools-0.7.0-py3-none-any.whl.

File metadata

  • Download URL: trexio_tools-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 48.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for trexio_tools-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0de647804fa1c6ecda273d4a67bddaef1a576fadad2122b9fd30abc60ebd8301
MD5 dd6da099d4ce773929661759331c1b1c
BLAKE2b-256 a9c51afedc02fc53eadbd2b598d60fe58ea99436f7e2aa9d8216c63acee3b95f

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