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

Uploaded Source

Built Distribution

chemiscope-0.6.0-py3-none-any.whl (2.6 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chemiscope-0.6.0.tar.gz
  • Upload date:
  • Size: 2.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for chemiscope-0.6.0.tar.gz
Algorithm Hash digest
SHA256 037f6d5ab0b9cefd060663391af452302c916e9e7de3b05505a268968ad57a46
MD5 c8457faaa01a260831e58e7cd8727e44
BLAKE2b-256 30e11f2b70a24d8485391a733db4b8ab696e273cdadcb6a5ba8ee77ae6a6f3fc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: chemiscope-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 2.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for chemiscope-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3e47d09276035cb85144b18c83c472db6f51a92c89578fd4581b3902f4974af5
MD5 a7dcb27ae52993b7d1a503fb2d5ce212
BLAKE2b-256 ad02d1abc5f31254e99d1cad8df20045d13daf1a7a563b40663cdaccba28c458

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