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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for chemiscope-0.5.0.tar.gz
Algorithm Hash digest
SHA256 957b475597c6059b149fff536963df0882a3c1a9936d6bd5890269709b6fb520
MD5 f4d5c4789a80cf6ffe948c18b950c459
BLAKE2b-256 7f99080698f986692eeeeb1743319519506fd5666520b9e146494e7a5d20e381

See more details on using hashes here.

File details

Details for the file chemiscope-0.5.0-py2.py3-none-any.whl.

File metadata

  • Download URL: chemiscope-0.5.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 2.6 MB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for chemiscope-0.5.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6193d12b4adf4d407fcbfd8af915b9ef4efa18798da0dc2a600eb99247ec82bf
MD5 aed4410494dc4b5c4b07bacebaa7e691
BLAKE2b-256 c6afb996b9e6e2ae5e6b642b99ac4215e9fd3b032fab684ac1a04595738e4567

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