Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
VHchavez authored Feb 19, 2020
1 parent 492383a commit 59ce1da
Showing 1 changed file with 79 additions and 13 deletions.
92 changes: 79 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,102 @@
<center> moly </center>


<p align="center">
<br>
<!--
<img src="docs/media/logo_vertical.png" alt="Blobs" height=300> <br><br>
-->
<img src="media/title.png" alt="moly" height=300> <br><br>
<a href="https://travis-ci.com/VHChavez/moly"><img src="https://travis-ci.com/VHChavez/moly.svg?branch=master" /></a>
<a href="https://lgtm.com/projects/g/VHchavez/moly/context:python"><img src="https://img.shields.io/lgtm/grade/python/g/VHchavez/moly.svg?logo=lgtm&logoWidth=18" /></a>
<a href="https://opensource.org/licenses/BSD-3-Clause"><img src="https://img.shields.io/badge/License-BSD%203--Clause-blue.svg" /></a>
<br>
</p>


Molecular visualization in Jupyter Notebooks.


### Features:
Geometry
Volumes (Density, MOs, ESP)

[//]: # (Badges)
### Supports:
xyz files
Psi4 geometries
QCElemental molecules
Cube files

<!---
[![codecov](https://codecov.io/gh/REPLACE_WITH_OWNER_ACCOUNT/moly/branch/master/graph/badge.svg)](https://codecov.io/gh/REPLACE_WITH_OWNER_ACCOUNT/moly/branch/master)
-->
### Installation
* pip:
```
pip install moly
```
* conda:
```
coming soon!
```
<br>
### Basic Geometry
*Define a figure and add elements to it. These can be molecues:*
```
import moly
caffeine = moly.molecule_factory("xyz", file='/caffeine.xyz')
fig = moly.Figure()
fig.add_molecule(caffeine)
fig.show()
```
#### Produces
<img src="/media/caffeine.png" alt="caffeine" height=300> <br>
<br>
A short description of the project.
### Basic Cube file
*Geometry and volumentric information can extracted from cube files.*
```
formal = moly.molecule_factory("Cube", file='orbitals.cube')
fig = moly.Figure()
fig.add_molecule(formal)
fig.add_blob(iso=0.05)
fig.show()
```
#### Produces
<img src="/media/formaldehyde.png" alt="formal" height=300> <br>
### Basic Layering
*Geometries can be brought from different sources and be thrown in the same figure*
```
#Implementation with QCArchive

### Copyright
import qcportal as ptl
client = ptl.FractalClient()

#Get molecule from QCArchive
ds = client.get_collection("ReactionDataset", "S22")
dimers = ds.get_molecules()
ammonia_dimer = dimers.loc['Ammonia Dimer', 'molecule'][0]

#Molecules
ammonia_dimer = moly.molecule_factory("QC", molecule=ammonia_dimer)
bucky = moly.molecule_factory("xyz", file='bucky.xyz')

#Figure, resolution and surface material can be changed
fig = moly.Figure(resolution=(800,800), surface="shiny")
fig.add_molecule(ammonia_dimer)
fig.add_molecule(bucky)
fig.show()
```
#### Produces
<img src="/media/bucky.png" alt="bucky" height=300> <br>
### Copyright
Copyright (c) 2020, VH Chavez
#### Acknowledgements

Project based on the
[Computational Molecular Science Python Cookiecutter](https://github.com/molssi/cookiecutter-cms) version 1.1.

0 comments on commit 59ce1da

Please sign in to comment.