Skip to main content

pyomovi

Build Status codecov

A Custom Jupyter Widget Library

Installation

You can install using pip:

pip install pyomovi

If you are using Jupyter Notebook 5.2 or earlier, you may also need to enable the nbextension:

jupyter nbextension enable --py [--sys-prefix|--user|--system] pyomovi

To create a visualizer window use the following code

import pyomovi
visualizer = pyomovi.Visualizer()
visualizer

Then in another cell (there is a bug, so the above must be executed 500ms before the next code) run e.g.

import numpy as np
positions = 100 * np.random.rand(1000000, 3)
visualizer.particle_positions = positions

to visualize 1 million atoms at random positions. If you want custom coloring and radii, you can

import numpy as np
visualizer.particle_positions = np.asarray([[0, 0, 0], [0,2,0], [0,2,2]])
visualizer.particle_colors = np.asarray([[255, 0, 0], [255, 255, 0], [255,255,255]]) # RGB
visualizer.particle_radii = np.asarray([1.0, 2.0, 3.0])

You can also set colors and radii using short names of atoms

import numpy as np
visualizer.particle_positions = np.asarray([[0, 0, 0], [0,2,0], [0,2,2]])
visualizer.set_atom_types(['O', 'H', 'H'])

Development Installation

Create a dev environment:

conda create -n pyomovi-dev -c conda-forge nodejs yarn python jupyterlab
conda activate pyomovi-dev

Install the python. This will also build the TS package.

pip install -e ".[test, examples]"

When developing your extensions, you need to manually enable your extensions with the notebook / lab frontend. For lab, this is done by the command:

jupyter labextension develop --overwrite .
yarn run build

For classic notebook, you need to run:

jupyter nbextension install --sys-prefix --symlink --overwrite --py pyomovi
jupyter nbextension enable --sys-prefix --py pyomovi

Note that the --symlink flag doesn't work on Windows, so you will here have to run the install command every time that you rebuild your extension. For certain installations you might also need another flag instead of --sys-prefix, but we won't cover the meaning of those flags here.

How to see your changes

Typescript:

If you use JupyterLab to develop then you can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the widget.

# Watch the source directory in one terminal, automatically rebuilding when needed
yarn run watch
# Run JupyterLab in another terminal
jupyter lab

After a change wait for the build to finish and then refresh your browser and the changes should take effect.

Python:

If you make a change to the python code then you will need to restart the notebook kernel to have it take effect.

Updating the version

To update the version, install tbump and use it to bump the version. By default it will also create a tag.

pip install tbump
tbump <new-version>

Metadata

Release files for pyomovi 0.18.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyomovi 0.18.0
File Size Uploaded Provenance Actions
pyomovi-0.18.0.tar.gz 1.3 MB Without provenance Details for pyomovi-0.18.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pyomovi 0.18.0
File Interpreter ABI Platform Actions
pyomovi-0.18.0-py3-none-any.whl Python 3 none any Details for pyomovi-0.18.0-py3-none-any.whl

Total release size: 3.1 MB

Release files / pyomovi-0.18.0.tar.gz

Download URL pyomovi-0.18.0.tar.gz
Size 1.3 MB
Tags Source
SHA-256 checksum
How to use checksums
355bfad46b8f29d0015d626737a4d8e502ab5fdd427a2cf4552078bffc7018f7
BLAKE2b-256 checksum
How to use checksums
d7c82fb7c3b2641b96b374d9e386ae8ce159c9bec2630082f68c34b59ddd68eb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.11.0

Release files / pyomovi-0.18.0-py3-none-any.whl

Download URL pyomovi-0.18.0-py3-none-any.whl
Size 1.8 MB
Tags Python 3
SHA-256 checksum
How to use checksums
54f1938464c215f4ea38bb9872a626ced6b7019560597d68ccd4798e8c080402
BLAKE2b-256 checksum
How to use checksums
2e3e49d71095fea2d06b1ac3a449b8bd0ae6d54fbcf406e47fcdfe4c6685d1d0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.11.0

Security for pyomovi 0.18.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page