Skip to main content

SCSD is Python software for the analysis of molecular conformation and deformation in crystal structures

Project description

SCSD

Symmetry-Coordinate Structural Decomposition - a tool for crystal structure analysis Dr. Christopher J. Kingsbury and Prof. Dr. Mathias O. Senge

Introduction

The scsd (symmetry-coordinate structural decomposition) program is a method of describing the concerted distortions of molecules in crystal structures using the idealised point group symmetry. This can be used for a number of purposes - including structure description, comparison and generation.

The latest version can be downloaded using the following command:

pip install scsdpy

This program can be accessed through a notebook interface by importing the underlying module. Many users may find operating through the web interface at https://www.kingsbury.id.au/scsd accessible and suitable. The analysis of known molecules can also be performed with scsd_mercury.py through the Mercury interface, with more information available on the ccdc-opensource repository (https://github.com/ccdc-opensource)

This work can be cited as below:

Kingsbury CJ, Senge MO. Quantifying Near-Symmetric Molecular Distortion Using Symmetry-Coordinate Structural Decomposition. ChemRxiv. 2024; doi:10.26434/chemrxiv-2024-6b25s

This citation will be updated after peer review.

While this repository contains tables referring to point groups other than those listed (C2v,C2h,D2d,D2h,D3h,D4h,D6h) these are not verified; check that the atom positions and their sums are in alignment and that the numbers make sense. Use at own risk.

Examples

A tutorial notebook is included to demonstrate model generation and analysis, database investigation and conformer generation.

  • notebooks/
    • scsd_tutorial.ipynb
    • data
      • bevron.pdb
      • puybaf.pdb
      • pispco.pdb
      • robsons.sd

Examples of integration of these tools with the csd-python-api interface are demonstrated; scsd_mercury.py and scsd_model_mercury.py are intended to be run through the csd-python-api menu in CCDC-Mercury.

scsd_collection_mercury.py and scsd_single_cl.py contain methods to import data through this interface, and requires a ccdc license.

  • scsd_mercury.py
  • scsd_model_mercury.py
  • scsd_collection_mercury.py

Dependencies:

  • numpy
  • scipy
  • seaborn
  • plotly
  • pandas
  • networkx
  • flask

Optional

  • ipympl
  • scikit-learn
  • werkzeug
  • ccdc

This work is licensed under THE ANTI-CAPITALIST SOFTWARE LICENSE (v 1.4)

To view a copy of this license, visit https://directory.fsf.org/wiki/License:ANTI-1.4 Commercial or military use is forbidden.

Please contact Chris Kingsbury (ckingsbury@ccdc.cam.ac.uk) for collaboration or with any questions

Ongoing issues

To Do List:

  • make 3-fold axis PCAs make sense - there isn't uniformity, and no way to 'normalise' currently
  • comments on the main program aspects
  • "Lacunary" - how to model when a part is missing? FeMoCo is part of this
  • extend sensibly to Oh ... ongoing work

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

scsdpy-0.1.0.tar.gz (18.1 MB view details)

Uploaded Source

Built Distribution

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

scsdpy-0.1.0-py3-none-any.whl (18.4 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scsdpy-0.1.0.tar.gz
  • Upload date:
  • Size: 18.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for scsdpy-0.1.0.tar.gz
Algorithm Hash digest
SHA256 881c645e52e02fff378db6feea689289eba34ad7654e85fd3966b204b11abdba
MD5 e87ab70d0e4f2b885912d00ae22b4510
BLAKE2b-256 7a62599f547328fda5852622120ab3d7244e4d5b5c6806532647dc29654e508d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scsdpy-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 18.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for scsdpy-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f57f712d3e3da370f0ac4ebb3133f4d61cff621623d317c8baf60d68f89b3fe1
MD5 e9d332bd545171c5283351833dd6d126
BLAKE2b-256 ad595d026dab32908c8134080b818021509e8cbe37606362f0558cd2566e46ba

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