Skip to main content

Python module for dealing with chemical coordinates.

Project description

# chemcoord: A python module for coordinates of molecules

<table>
<tr>
<td>Latest Release</td>
<td>
<a href="https://pypi.python.org/pypi/chemcoord">
<img src="https://img.shields.io/pypi/v/chemcoord.svg" alt="latest release" />
</a>
</td>
<tr>
<td>Package Status</td>
<td>
<a href="https://pypi.python.org/pypi/chemcoord">
<img src="https://img.shields.io/pypi/status/chemcoord.svg"
alt="status" />
</a>
</td>
</tr>
<tr>
<td>License</td>
<td>
<a href="https://www.gnu.org/licenses/lgpl-3.0.en.html">
<img src="https://img.shields.io/pypi/l/chemcoord.svg" alt="license" />
</a>
</td>
</tr>
<tr>
<td>Build Status</td>
<td>
<a href="https://travis-ci.org/mcocdawc/chemcoord">
<img src="https://travis-ci.org/mcocdawc/chemcoord.svg?branch=master"
alt="travis build status" />
</a>
</td>
</tr>
<tr>
<td>Code Quality</td>
<td>
<a href="https://landscape.io/github/mcocdawc/chemcoord/master">
<img src="https://landscape.io/github/mcocdawc/chemcoord/master/landscape.svg?style=flat"
alt="Code Health" />
</a>
</td>
</tr>
<tr>
<td>Coverage</td>
<td>
<a href="https://codecov.io/gh/mcocdawc/chemcoord">
<img src="https://codecov.io/gh/mcocdawc/chemcoord/branch/master/graph/badge.svg" alt="Codecov" />
</a>
</td>
</tr>
</table>

## Website

The project's website with documentation is: http://chemcoord.readthedocs.org/


## Features

* Molecules are reliably transformed between cartesian space and
non redundant internal coordinates (Zmatrices).
Dummy atoms are inserted and removed automatically on the fly if necessary.
* The created Zmatrix is not only a structure expressed in internal coordinates,
it is a "chemical" Zmatrix.
"Chemical" Zmatrix means, that e.g. distances are along bonds
or dihedrals are defined as they are drawn in chemical textbooks
(Newman projections).
* Analytical gradients for the transformations between the different
coordinate systems are implemented.
* Performance intensive functions/methods are implemented
with Fortran/C like speed using [numba](http://numba.pydata.org/).
* Geometries may be defined with symbolic expressions using
[sympy](http://www.sympy.org/en/index.html).
* Built on top of [pandas](http://pandas.pydata.org/) with very similar syntax.
This allows for example distinct label or row based indexing.
* It derived from my own work and I heavily use it during the day.
So all functions are tested and tailored around the work flow in
theoretical chemistry.
* The classes are safe to inherit from and can easily be customized.
* [It as a python module ;)](https://xkcd.com/353/)


## Installation guide
A working python installation is required (2.7 and >=3.5 are possible).

It is highly recommended to use this module in combination with
[Ipython](http://ipython.org/) and [jupyter](http://jupyter.org/).
They come shipped by default with the
[anaconda3 installer](https://www.continuum.io/downloads/)

### Unix


For the packaged versions, the following commands have to be executed in the
terminal:
```
conda install -c mcocdawc chemcoord
```
or
```
pip install chemcoord
```
For the up to date development version (experimental):
```
git clone https://github.com/mcocdawc/chemcoord.git
cd chemcoord
pip install .
```

### Windows

Neither installation nor running the module are tested on windows.
To the best of my knowledge it should work there as well.
Just use the same steps as for UNIX.

### Changelog

the changelog can be found
[here](https://github.com/mcocdawc/chemcoord/blob/master/changelog.md).


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

chemcoord-2.0.3-py2.py3-none-any.whl (133.7 kB view details)

Uploaded Python 2Python 3

File details

Details for the file chemcoord-2.0.3-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for chemcoord-2.0.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 59a69461e47118967fc79c4165639cde6b3a6d9b04aae9bb22c2fbfafdda9650
MD5 bcff53ef0204df5b4c821574be7b9971
BLAKE2b-256 675b2b7c6ec2665e84e8ce9c752b8227285ce5e57407947a665a700ded2598f0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page