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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for chemiscope-0.7.2.tar.gz
Algorithm Hash digest
SHA256 1b6dfd081a2fc2292ab94612ad2df22b80b3aaa26c419206e51164aa54c66172
MD5 fbf2af15f2a4501c2102abbfcf9e98db
BLAKE2b-256 d7aaa39330bf54edc5f0e31a5b79f3eee2153b61498c551d93fb1c3ab643bb4c

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for chemiscope-0.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 70c1547295057a1f7e80eca8de0fc3fe4042c246014c0e74f627cf62b45193d7
MD5 c7bde6df224b0fed6383bcc5fab909c3
BLAKE2b-256 1a3d4dc622b7b7065df26ddba51f9f6c672acb99ca220911dcb73e90a4b972b1

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