Skip to main content

OctaDist: A tool for calculating distortion parameters in coordination complexes.

Project description

Python version PyPI-Server Python Wheel Code size Repo size

Github Download All releases Github Download Latest version

OctaDist

Octahedral distortion calculator: A tool for calculating distortion parameters in coordination complexes. https://octadist.github.io/

molecule

Standard abilities

OctaDist is computer software for inorganic chemistry and crystallography program. OctaDist can be used for studying the structural distortion in coordination complexes. With the abilities of OctaDist, you can:

  • analyze the structure and conformation of coordination complexes.
  • compute the octahedral distortion parameters.
  • explore tilting distortion in perovskite and metal-organic framework.
  • display 3D molecule and other graphical analysis.
  • upgrade your and other program with OctaDist abilities.

Development and Release

OctaDist is written entirely in Python 3 binding to Tkinter GUI toolkit. It is cross-platform program which can work on multiple operating systems. The stable version and development build of OctaDist are released at here. A standalone executable for graphical user interface (GUI) and source code for command line interface (CLI) are available for as follows:

Platform Description Usability Status
Windows A standalone executable GUI Travis-CI Test
Linux Source code as a Python package GUI & CLI Travis-CI Test
macOS Source code as a Python package CLI Travis-CI Test
PyPI library PyPI-Server CLI Travis-CI Test
Anaconda cloud Conda-Server CLI Travis-CI Test
Nightly build Development build GUI & CLI Travis-CI Test

Documents

User manual : https://octadist.github.io/manual.html.

Reference manual :

Version Status Docs
Stable Doc-Latest-Badge HTML / PDF / Epub
Dev Build Doc-Nightly-Badge HTML / PDF / Epub

Installing

The easiest way to install OctaDist is to use pip.

pip install octadist

or use conda for those who have Anaconda installed on your system.

conda install -c rangsiman octadist

To execute OctaDist package, use the following command:

python -m octadist.Run

Note that you have to stay at the top-level directory (outside octadist).

Running the tests

Graphical User Interface (GUI)

Just download a standalone executable to your system.

OctaDist GUI XYZ coordinates Computed distortion parameters

Command Line Interface (CLI)

Example 1

import octadist as oc

# Prepare list of atomic coordinates of octahedral structure:

atom = ['Fe', 'O', 'O', 'N', 'N', 'N', 'N']

coord = [[2.298354000, 5.161785000, 7.971898000],  # <- Metal atom
         [1.885657000, 4.804777000, 6.183726000],
         [1.747515000, 6.960963000, 7.932784000],
         [4.094380000, 5.807257000, 7.588689000],
         [0.539005000, 4.482809000, 8.460004000],
         [2.812425000, 3.266553000, 8.131637000],
         [2.886404000, 5.392925000, 9.848966000]]

dist = oc.CalcDistortion(coord)
zeta = dist.zeta             # Zeta
delta = dist.delta           # Delta
sigma = dist.sigma           # Sigma
theta = dist.theta           # Theta

Example of output for computed parameters:

Computed parameters
-------------------
Zeta  = 0.228072561
Delta = 0.000476251
Sigma = 47.92652837
Theta = 122.6889727

Example 2

OctaDist can display the 3D structure of molecule.

import octadist as oc

file = r"../example-input/Multiple-metals.xyz"

atom_full, coord_full = oc.molecule.extract_coord(file)

my_plot = oc.draw.DrawComplex(atom=atom_full, coord=coord_full)
my_plot.add_atom()
my_plot.add_bond()
my_plot.add_legend()
my_plot.save_img()
my_plot.show_plot()

# Figure will be saved as Complex_saved_by_OctaDist.png by default.

molecule

Other example scripts and octahedral complexes are available at example-py and example-input.

Citation

Please cite this project when you use OctaDist for scientific publication.

OctaDist - A tool for calculating distortion parameters in coordination complexes.
https://octadist.github.io

Bug report

If you found issues in OctaDist, please report it to us at here.

Project team

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

octadist-2.5.4.5.tar.gz (55.9 kB view details)

Uploaded Source

Built Distribution

octadist-2.5.4.5-py3-none-any.whl (78.3 kB view details)

Uploaded Python 3

File details

Details for the file octadist-2.5.4.5.tar.gz.

File metadata

  • Download URL: octadist-2.5.4.5.tar.gz
  • Upload date:
  • Size: 55.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

File hashes

Hashes for octadist-2.5.4.5.tar.gz
Algorithm Hash digest
SHA256 0afdbe68359e5c3228e3baf23d2e5fad07a6f5981a432b3a8caaba3affbf1d5b
MD5 1b2d7b9d620caddec65ddf5dec960336
BLAKE2b-256 2484a21908e912ba096e596910c65162d20ee7a943419b265df068b21501f0ac

See more details on using hashes here.

File details

Details for the file octadist-2.5.4.5-py3-none-any.whl.

File metadata

  • Download URL: octadist-2.5.4.5-py3-none-any.whl
  • Upload date:
  • Size: 78.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

File hashes

Hashes for octadist-2.5.4.5-py3-none-any.whl
Algorithm Hash digest
SHA256 e693c8c0d009bf9726d57754989a6efd0611800ef629e840edeaaf4e3f52fe35
MD5 1b97204636b6b8d9092837e6a6577c32
BLAKE2b-256 b8214749acedc5e23bfd6fd1fd0a450cbe5c3283f56a5ddf6d38c2b77bacbc6b

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