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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: chemiscope-0.7.1.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.1.tar.gz
Algorithm Hash digest
SHA256 5a1d2c1ff98ebaf1528a5dbb6d97451edc9ef6477517b62616d41696bca413c7
MD5 5a21e3fdb7254d83aead08c908ae4c1c
BLAKE2b-256 3fd924b1d4fd25bf3e1daa580a722afce0cd7b5ce765d1528d3a43dd0cd7740d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: chemiscope-0.7.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5b7b38864f8aec5f1fb52d6cee2b760e828aa4f12e2575b4d2eaa76127ab2ea7
MD5 196c87cee0a69e899738f4de286c3464
BLAKE2b-256 452fa1723303cac2783e891eb155cec2924ea3bae4dff195fc34168631b33f39

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