Skip to main content

cmlkit plugin for the dscribe package

Project description

cscribe 🐫🖋️

PyPI - Python Version PyPI Code style: black

cscribe is a cmlkit plugin for dscribe.

It provides cmlkit-style Components for the representations implemented in dscribe. At the moment, it supports:

  • SOAP: Supported, tested, used in repbench.
  • SF: Supported, but only g2 and g4. Untested in production.
  • MBTR: Supported, but untested in production. Local MBTR is also supported, but also untested.
  • Coulomb matrix, sine matrix, or ewald sum matrix are not currently supported. (Please submit a pull request!)

In general, cscribe implements a subset of the full capabilities of dscribe, in order to stay consistent with the choices made in cmlkit. For instance, you can't specify whether periodic is turned on or not, and sparse is not implemented. Please feel free to build your own customised Components based on the code here!

The exact parameters are documented in the code itself, please have a look!

Installation

pip install cscribe
export CML_PLUGINS=cscribe

Or add cscribe to $CML_PLUGINS in your .bashrc or equivalent.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for cscribe, version 0.3.1
Filename, size File type Python version Upload date Hashes
Filename, size cscribe-0.3.1-py3-none-any.whl (21.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size cscribe-0.3.1.tar.gz (8.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page