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.1.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.1-py3-none-any.whl (18.4 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scsdpy-0.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 23d07ab87c5d3dc40d8a11725ff5451ef4d953ff279892849fa11238b86f119e
MD5 4f3f4d6d1c709aefc3f231cb9b2f25b4
BLAKE2b-256 572f78b8452b525c5f6feab0f7f3f027baea5cd9f070b6523ef28eabd9380d93

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scsdpy-0.1.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a62336706177eb1e7e4463a8051122176d7ba34d38c68bdf2ee874ebcf4e9ce6
MD5 dae287625869bde19cd66640d55e2b48
BLAKE2b-256 fb56abd7a1785a28178965f6c8b19910d417c397cbed0d23bdcd7adc79c4e55e

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