Skip to main content

A GUI tool to set and adjust unit cell parameters for molecular structures.

Project description

CelleditPy

License

CelleditPy is a Python-based GUI application designed for crystallographers and computational chemists. It provides a visual, interactive environment to load molecular structures (from .mol or .cif files), define or adjust unit cell parameters, and reposition the molecule within the cell before saving the result as a .cif file.

This tool is built using PyQt6, PyVista, and ASE (Atomic Simulation Environment).

(Suggestion: Add a screenshot of your application here)

Features

  • Load Structures: Load molecular structures from .mol and .cif files.
  • Save as CIF: Save the final structure, including the unit cell, in .cif format.
  • Interactive Cell Editing: Manually set or adjust unit cell parameters (a, b, c, alpha, beta, gamma).
  • Auto-Fit Cell: Automatically calculate and apply the minimum cell dimensions (a, b, c) required to contain the molecule, while preserving the current cell angles.
  • 3D Manipulation:
    • Translation: Move the molecule along Cartesian (XYZ) axes or fractional cell (ABC) axes.
    • Rotation: Rotate the molecule around Cartesian (XYZ) axes (centered on a selected atom) or cell (ABC) axes (centered on the axis itself).
  • Molecule Fitting:
    • Fit Molecule to Axis: Align the molecule to a specific cell axis (a, b, or c) by defining the molecular direction using two or more atoms.
    • Fit in Cell (Auto-fit): Automatically detects atoms lying on a cell axis, fixes them, and rotates the rest of the molecule to best fit within the cell boundaries.
  • Coordinate Wrapping: Wrap atomic coordinates to fit all atoms inside the defined unit cell (0.0 to 1.0 fractional coordinates).
  • Visualization:
    • 3D visualization powered by PyVista.
    • Toggle the display of atom indices.
    • Reset the camera view.

Installation

Prerequisites:

  • Python 3.8+
  • The following libraries (and their dependencies) are required:
    • PyQt6
    • pyvista
    • pyvistaqt
    • ase
    • numpy
    • scipy

These dependencies will be installed automatically when installing the package.

Install from Source:

Install the package using pip. This will also install all required dependencies and register the command-line entry point. bash pip install celleditpy

Usage

After installation, you can run the application by simply typing the following command in your terminal:

celleditpy

This will launch the main application window.

License

This project is licensed under the Apache-2.0 License. See the LICENSE file for details.

Author

  • HiroYokoyama

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

celleditpy-0.1.5.tar.gz (19.8 kB view details)

Uploaded Source

Built Distribution

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

celleditpy-0.1.5-py3-none-any.whl (20.0 kB view details)

Uploaded Python 3

File details

Details for the file celleditpy-0.1.5.tar.gz.

File metadata

  • Download URL: celleditpy-0.1.5.tar.gz
  • Upload date:
  • Size: 19.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for celleditpy-0.1.5.tar.gz
Algorithm Hash digest
SHA256 3f236fb834dc9ddb8fdfcc3453b2ed1b4b3c206adee9486c3c63d99b0d3f841d
MD5 9e8f13cf67e53b2274610cd8cb04d16e
BLAKE2b-256 1eca0b3aca240f73fad97c917069bd228107b063900739fd4039196a4d3097da

See more details on using hashes here.

File details

Details for the file celleditpy-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: celleditpy-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 20.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for celleditpy-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 223ee7a83772584e9aaef1fbb1c15352d52e621e1f293dc82a35e1e2680a266c
MD5 9f8b036d46679444582f324c0735a388
BLAKE2b-256 ceedc13b6ba34d0818440df08f1f98189a66a60dd883d7832b99b02dd4c40646

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