Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/autodesk/notebook-molecular-visualization
2D and 3D molecular visualization in Jupyter notebooks using 3DMol.js and D3.js
https://github.com/autodesk/notebook-molecular-visualization
Last synced: 5 days ago
JSON representation
2D and 3D molecular visualization in Jupyter notebooks using 3DMol.js and D3.js
- Host: GitHub
- URL: https://github.com/autodesk/notebook-molecular-visualization
- Owner: Autodesk
- License: apache-2.0
- Created: 2016-07-14T17:36:39.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-03-30T15:55:15.000Z (over 6 years ago)
- Last Synced: 2024-04-13T22:59:03.621Z (7 months ago)
- Language: Python
- Homepage: http://moldesign.bionano.autodesk.com
- Size: 15.1 MB
- Stars: 71
- Watchers: 11
- Forks: 21
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
notebook-molecular-visualization
===============================
[](https://badge.fury.io/py/nbmolviz)
Jupyter notebook add-ons for the [Molecular Design Toolkit](https://github.com/Autodesk/molecular-design-toolkit). NBMolViz provides visualization and interactivity for 3D Molecular Structures in Jupyter notebooks.
After installing it, you'll never need to use the NBMolViz package directly. It's instead called through MDT to provide enhanced functionality in notebooks.
## Installation
When you install `nbmolviz`, you'll need to both install the python library _and_ enable the notebook extensions.
1. **Install the python library:**
```bash
$ pip install nbmolviz
```
2. **Activate notebook extensions:**
To enable for your user account:
```bash
$ python -m nbmolviz activate --user
```
To enable within your current virtual environment:
```bash
$ python -m nbmolviz activate --sys-prefix
```
To globally enable for all users (use with caution! This may require `sudo`):
```bash
$ python -m nbmolviz activate --global
```
## Upgrading from older versions
1. **Upgrade the library to the newest version**
$ pip install --upgrade nbmolviz
2. **Remove old notebook extensions (you will be notified if it's necessary to run with `sudo`)**:
```bash
$ python -m nbmolviz uninstall
```
3. Activate the notebook extension as above
## Examples
Draw a small molecule:
```python
import moldesign as mdt
mol = mdt.from_name('ethylene')
mol.draw()
```
Draw a protein:
```python
import moldesign as mdt
mol = mdt.from_pdb('3aid')
mol.draw()
```
Interactively select atoms (the currently selected atoms will be available as `selector.selected_atoms`)
```python
import moldesign as mdt
mol = mdt.from_pdb('3aid')
selector = mdt.widgets.ResidueSelector(mol)
selector
```
## Dev install
Requires npm.
$ git clone https://github.com/autodesk/notebook-molecular-visualization
$ cd notebook-molecular-visualization
# ./set_filters.sh # tells git to clean up notebooks before committing
$ python setup.py jsdeps
$ pip install -e .
$ jupyter nbextension install --py --symlink --user nbmolviz
$ jupyter nbextension enable --py --user nbmolviz
$ cd tests/galileo && npm install
This will build your widgets into a folder at `notebook-molecular-visualization/nbmolviz/static`
During development, to see the effects of changes to any javascript files (in notebook-molecular/visualization/js/src), run `python setup.py jsdeps` and reload any notebook browser windows.
## To run visual tests
`cd tests/nb && ../galileo/bin/galileo --launchnb`
## Releasing a new version
Travis automatically releases commits that are tagged, so to trigger a new release, just do:
git tag
git push origin --tags
If you want to see what will be included in a release, run `check-manifest`. You could also manually build a release with `python setup.py sdist` and manually release with `python setup.py sdist upload -r pypi`.
## Contributing
This project is developed and maintained by the [Molecular Design Toolkit](https://github.com/autodesk/molecular-design-toolkit) project. Please see that project's [CONTRIBUTING document](https://github.com/autodesk/molecular-design-toolkit/CONTRIBUTING.md) for details.
## About
This package started life as hackathon project for the CECAM 2015 Macromolecular Simulation Workshop. It's since undergone a complete source rewrite, and is being released by BioNano Research at Autodesk as part of our suite of Molecular Design Tools.
The visualizers offered by this library were built using:
- ipywidgets - UI library for interactivity in Jupyter notebooks
- 3Dmol.js - 3D molecular visualization library for web browsers
- D3.js - javascript library for graph visualization
## License
Copyright 2017 Autodesk Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.