Skip to main content

2D small molecule visualization for MDAnalysis

Project description

MDonatello

Latest release Last release tag GitHub commits since latest release (by date) for a branch Documentation Status
Workflows Linux_CI_CD MacOS_CI_CD Windows_CI_CD
Status codecov Code style: black
Community License: GPL v2 Powered by MDAnalysis

2D small molecule visualization for MDAnalysis

This Repository is part of the Google Summer of Code 2024 for the following project: 2D Visualization for small molecules

The following Release is the submission for the GSoC 2024 Evaluation: GSoC 2024: 2D visualization for small molecules Release

Here is the final report for the GSoC2024 Project: GSoC 2024 - 2D visualization for small molecules

MDonatello is bound by a Code of Conduct.

Installation

To build MDonatello from source, First clone the repository:

git clone https://github.com/talagayev/MDonatello

Create a virtual environment and activate it:

conda create --name mdonatello
conda activate mdonatello

Then go into the MDonatello folder:

cd MDonatello

Finally this package from source:

pip install -e .

Running MDonatello

To use the mdonatello package you need to run a jupyter notebook, thus run the command:

jupyter notebook

Now that you started a jupyter notebook create a notebook file and enter the following command to use mdonatello:

import MDAnalysis as mda
import mdonatello
from mdonatello import MoleculeVisualizer

u = mda.Universe("input.pdb")
ag = u.select_atoms("resname UNK")
visualizer = MoleculeVisualizer(ag, show_atom_indices=False, width=-1, height=-1)

For a more detailed use of MDonatello and an example of the output follow the instructions in this section:

Running MDonatello

Copyright

The MDonatello source code is hosted at https://github.com/talagayev/mdonatello and is available under the GNU General Public License, version 2 (see the file LICENSE).

Copyright (c) 2024, Valerij Talagayev

Acknowledgements

Project based on the MDAnalysis Cookiecutter version 0.1. Please cite MDAnalysis when using MDonatello in published work.

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

mdonatello-0.0.1.tar.gz (455.1 kB view hashes)

Uploaded Source

Built Distribution

mdonatello-0.0.1-py3-none-any.whl (462.5 kB view hashes)

Uploaded Python 3

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