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.

Source Distribution

cscribe-0.3.1.tar.gz (8.3 kB view details)

Uploaded Source

Built Distribution

cscribe-0.3.1-py3-none-any.whl (21.9 kB view details)

Uploaded Python 3

File details

Details for the file cscribe-0.3.1.tar.gz.

File metadata

  • Download URL: cscribe-0.3.1.tar.gz
  • Upload date:
  • Size: 8.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.11 CPython/3.7.2 Darwin/18.7.0

File hashes

Hashes for cscribe-0.3.1.tar.gz
Algorithm Hash digest
SHA256 91944fa1bf0a3b0022e6dc1e1600dcfc2e96ff3f68ba09b02a5016dd29ed98f2
MD5 aee7de23e3432563cbab4ab3e60d3155
BLAKE2b-256 ef07ca8c5a56eb4addf24406e36bca9fa99b577fcd9b7f2d11ff8497f3164d22

See more details on using hashes here.

File details

Details for the file cscribe-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: cscribe-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 21.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.11 CPython/3.7.2 Darwin/18.7.0

File hashes

Hashes for cscribe-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 921a8f12996b1c20c5777a18ca7bf880c9c8710ffe5e106c0c6109ef013ef6cb
MD5 4903a80d4c9f0824e215532462b44852
BLAKE2b-256 9ddbdaa039aaafd6ab34678ac9a29fc55239f9b92b2d0dd89ec1bd5a439c4106

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