Skip to main content

A package to process ouput of PIOUD

Project description

pioud_process

A Python package for generating input and processing output of PIOUD (A Path Integral Molecular Dynamicscode integrated with Quantum ESPRESSO).

Features

  • GUI Interface: A user-friendly graphical interface for:
    • Generating input files for PIOUD from and .cif crystal structure files.
    • Creating submission scripts for HPC clusters (PBS/SLURM).
    • Visualizing and setting up simulation parameters.

pioud_process GUI

  • Analysis Tools:
    • Time averaging of properties.
    • Radial Distribution Function (RDF) analysis.
    • SOAP (Smooth Overlap of Atomic Positions) analysis.
    • MBTR (Many-Body Tensor Representation) analysis.
    • Autocorrelation function calculation.

Installation

From PyPI (Recommended)

pip install pioud-process

From Source

To install the package from source, clone the repository and install it using pip:

git clone https://github.com/Aadhityan-A/pioud_process.git
cd pioud_process
pip install .

For development mode, use:

pip install -e .

Usage

Graphical User Interface (GUI)

After installation, you can launch the GUI using the command line:

pioud-process

The GUI allows you to:

  1. File Input: Upload CIF files and set calculation prefixes.
  2. PIMD Parameters: Configure Path Integral Molecular Dynamics settings (beads, blocks, steps, temperature, etc.).
  3. QE Parameters: Set up Quantum ESPRESSO SCF parameters (cutoffs, k-points, smearing, etc.).
  4. HPCC Submit: Generate submission scripts for PBS or SLURM schedulers.

Library Usage

You can also use the analysis modules directly in your Python scripts:

from pioud_process.time_average import calculate_qe_time_averaged_properties

# Example usage
# results = calculate_qe_time_averaged_properties(path_to_data, start_step, end_step)

Dependencies

  • numpy
  • ase
  • scipy
  • dscribe
  • skmatter
  • tkinter (usually included with Python)

License

This software is governed by the CeCILL license under French law and abiding by the rules of distribution of free software. You can use, modify and/ or redistribute the software under the terms of the CeCILL license as circulated by CEA, CNRS and INRIA at the following URL "http://www.cecill.info".

See the LICENSE file for details.

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

pioud_process-0.1.0.tar.gz (40.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pioud_process-0.1.0-py3-none-any.whl (49.1 kB view details)

Uploaded Python 3

File details

Details for the file pioud_process-0.1.0.tar.gz.

File metadata

  • Download URL: pioud_process-0.1.0.tar.gz
  • Upload date:
  • Size: 40.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for pioud_process-0.1.0.tar.gz
Algorithm Hash digest
SHA256 4816379ce38ad90fa3f77731d439928bae5f725b39e589fcabe6d462ebb74bdd
MD5 4ab2047ffdbc3ca0377a92fbaf321c35
BLAKE2b-256 3182856e49a54a561f3c96be74434c1a2882853b53c06a109d869e2eafdbe796

See more details on using hashes here.

File details

Details for the file pioud_process-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: pioud_process-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 49.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for pioud_process-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 13b5549be7684f5db8c471fffca4215710ce515c30851b0a66107a2792af1ec4
MD5 51cf36df541f4a4dff55f3c138ad5e6f
BLAKE2b-256 93bf10e8992451422fc911cb6200f9b9efe1927b0e35d243a65fd0c4c4d1bc5c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page