# Python helpers for chemiscope
This package contains Python code to help generate input files for the
[chemiscope](https://chemiscope.org) default visualizer, and integrate
chemiscope with jupyter notebooks.
## Installation
You should use pip to install this package:
```bash
pip install chemiscope
```
This installs both a `chemiscope-input` command line tool, and the `chemiscope`
package.
## Usage
To create a new chemiscope input file:
```python
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:
```python
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)
```
Raw data
{
"_id": null,
"home_page": null,
"name": "chemiscope",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "visualization, materials science, chemistry, molecules",
"author": null,
"author_email": "Guillaume Fraux <guillaume.fraux@epfl.ch>",
"download_url": "https://files.pythonhosted.org/packages/bc/50/34dccb848ad3b484dd3a11b6a5c9d57d12e27e6d8ccdf79a938838aa314e/chemiscope-0.6.1.tar.gz",
"platform": null,
"description": "# Python helpers for chemiscope\n\nThis package contains Python code to help generate input files for the\n[chemiscope](https://chemiscope.org) default visualizer, and integrate\nchemiscope with jupyter notebooks.\n\n## Installation\n\nYou should use pip to install this package:\n\n```bash\npip install chemiscope\n```\n\nThis installs both a `chemiscope-input` command line tool, and the `chemiscope`\npackage.\n\n## Usage\n\nTo create a new chemiscope input file:\n\n```python\nimport chemiscope\nimport ase.io\n\n# read frames using ase\nframes = ase.io.read(\"structures.xyz\", \":\")\n\n# add additional properties to display\nproperties = {\n \"<property name>\": {\n target: \"atom\",\n values: [3, 4, 2, 8, 9, 10],\n }\n}\n\nchemiscope.write_input(\"my-input.json.gz\", frames=frames, properties=properties)\n```\n\nTo display a chemiscope widget inside a jupyter notebook:\n\n```python\nimport chemiscope\nimport ase.io\n\n# read frames using ase\nframes = ase.io.read(\"structures.xyz\", \":\")\n\n# add additional properties to display\nproperties = {\n \"<property name>\": [3, 4, 2, 8, 9, 10],\n}\n\nchemiscope.show(frames=frames, properties=properties)\n```\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Helpers to work with the chemiscope interactive structure/property explorer for materials and molecules",
"version": "0.6.1",
"project_urls": {
"documentation": "https://chemiscope.org/docs/",
"homepage": "https://chemiscope.org",
"repository": "https://github.com/lab-cosmo/chemiscope"
},
"split_keywords": [
"visualization",
" materials science",
" chemistry",
" molecules"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8eaff1a560d132a1197077e4f5a83255ad73fffd1a0df84c696ee5f6260c4be3",
"md5": "6b26b0e42ce72a5ede5a33178b8d17de",
"sha256": "fadb77c8e537e88f7f7d17ecb80a4d11fa8b4c3abe2ac94a4bc152e30c257ecc"
},
"downloads": -1,
"filename": "chemiscope-0.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6b26b0e42ce72a5ede5a33178b8d17de",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 2751033,
"upload_time": "2024-03-21T16:18:36",
"upload_time_iso_8601": "2024-03-21T16:18:36.170864Z",
"url": "https://files.pythonhosted.org/packages/8e/af/f1a560d132a1197077e4f5a83255ad73fffd1a0df84c696ee5f6260c4be3/chemiscope-0.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bc5034dccb848ad3b484dd3a11b6a5c9d57d12e27e6d8ccdf79a938838aa314e",
"md5": "1ea1a58a48f001a1b84811f94223cddd",
"sha256": "7871761e693253cd5f2b6844299accdffed78d5fabd18f5d22e72316923ebc1b"
},
"downloads": -1,
"filename": "chemiscope-0.6.1.tar.gz",
"has_sig": false,
"md5_digest": "1ea1a58a48f001a1b84811f94223cddd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 2743696,
"upload_time": "2024-03-21T16:18:37",
"upload_time_iso_8601": "2024-03-21T16:18:37.926824Z",
"url": "https://files.pythonhosted.org/packages/bc/50/34dccb848ad3b484dd3a11b6a5c9d57d12e27e6d8ccdf79a938838aa314e/chemiscope-0.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-21 16:18:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lab-cosmo",
"github_project": "chemiscope",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "chemiscope"
}
JSON
