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 = 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 = 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.6.1.tar.gz (2.7 MB view details)

Uploaded Source

Built Distribution

chemiscope-0.6.1-py3-none-any.whl (2.8 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for chemiscope-0.6.1.tar.gz
Algorithm Hash digest
SHA256 7871761e693253cd5f2b6844299accdffed78d5fabd18f5d22e72316923ebc1b
MD5 1ea1a58a48f001a1b84811f94223cddd
BLAKE2b-256 bc5034dccb848ad3b484dd3a11b6a5c9d57d12e27e6d8ccdf79a938838aa314e

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for chemiscope-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fadb77c8e537e88f7f7d17ecb80a4d11fa8b4c3abe2ac94a4bc152e30c257ecc
MD5 6b26b0e42ce72a5ede5a33178b8d17de
BLAKE2b-256 8eaff1a560d132a1197077e4f5a83255ad73fffd1a0df84c696ee5f6260c4be3

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