Skip to main content

Helpers to work with the chemiscope interactive structure/property explorer for materials and molecules

Project description

Python helpers for chemiscope

This package contains Python code to help generate input files for the chemiscope default visualizer, and integrate chemiscope with jupyter notebooks.

Installation

You should use pip to install this package:

pip install chemiscope

This installs both a chemiscope-input command line tool, and the chemiscope package.

Usage

To create a new chemiscope input file:

import chemiscope
import ase.io

# read frames using ase
# frames can also be stk objets, e.g.
# frames = [stk.BuildingBlock(smiles="NCCN")]
frames = ase.io.read("structures.xyz", ":")

# add additional properties to display
properties = {
    "<property name>": {
        target: "atom",
        values: [3, 4, 2, 8, 9, 10],
    }
}

chemiscope.write_input("my-input.json.gz", frames=frames, properties=properties)

To display a chemiscope widget inside a jupyter notebook:

import chemiscope
import ase.io

# read frames using ase
# frames can also be stk objets, e.g.
# frames = [stk.BuildingBlock(smiles="NCCN")]
frames = ase.io.read("structures.xyz", ":")

# add additional properties to display
properties = {
    "<property name>": [3, 4, 2, 8, 9, 10],
}

chemiscope.show(frames=frames, properties=properties)

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

chemiscope-0.8.1.tar.gz (3.7 MB view details)

Uploaded Source

Built Distribution

chemiscope-0.8.1-py3-none-any.whl (3.7 MB view details)

Uploaded Python 3

File details

Details for the file chemiscope-0.8.1.tar.gz.

File metadata

  • Download URL: chemiscope-0.8.1.tar.gz
  • Upload date:
  • Size: 3.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.9

File hashes

Hashes for chemiscope-0.8.1.tar.gz
Algorithm Hash digest
SHA256 7d2229531d569fd37112e46e2640a241609311ce07ef7ffce98399a1536c9cfc
MD5 175eb58745a380de176e87224bb1655c
BLAKE2b-256 66068b114c2b15cc30d6d9aa9149f18956586c3a21d88f7a5df29568f87893cd

See more details on using hashes here.

File details

Details for the file chemiscope-0.8.1-py3-none-any.whl.

File metadata

  • Download URL: chemiscope-0.8.1-py3-none-any.whl
  • Upload date:
  • Size: 3.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.9

File hashes

Hashes for chemiscope-0.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1522a680bf245a192cddbca50cac3d935ac65178dc60189361026b681da025b5
MD5 575b90f560e0d3ebe220155dccff2f5f
BLAKE2b-256 920d1764c2fbfcddee6f03afc3e316badcd619bec5f1388520615571cabb36e3

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