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.7.0.tar.gz (3.6 MB view details)

Uploaded Source

Built Distribution

chemiscope-0.7.0-py3-none-any.whl (3.6 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for chemiscope-0.7.0.tar.gz
Algorithm Hash digest
SHA256 d7c36bdcfcff4f34411f4ef2f83d0ce0fc3f13b572f63b4a61ce217bda5da0bf
MD5 fbb23912df28a18ce049dfa5d393e7fd
BLAKE2b-256 b8073a8ce16b605b24c50d181aea9c8ab92faaa30a95213e6bfd43ba72a0d1dd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: chemiscope-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 3.6 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.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4f4957f07439cff8f979fed3d743e955cee550282de41ff967beb8d75882c4e1
MD5 14a5224f533b941c64d79a2db1d27293
BLAKE2b-256 0e21fa9967461789a33fed2f8519bf3ef614b53b4596117cd4728ed1ae20700d

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