Skip to content

Latest commit

 

History

History
47 lines (41 loc) · 2.26 KB

README.md

File metadata and controls

47 lines (41 loc) · 2.26 KB

Travis CI AppVeyor Codecov Documentation Status

Ångström is a Python package for geometric molecular operations, molecular visualization and animations. The purpose of Ångström is to be a lightweight and easily integrable package. This way it can be easily included in various simulation packages. Ångström offers high quality molecular visualization from the command-line. It provides easy integration with visualization software such as:

Installation

You can install Ångström by cloning this repository as follows:

git clone https://github.com/kbsezginel/angstrom.git
cd angstrom
python setup.py install

Documentation

Ångström documentation is available on readthedocs.

Visualization

In order to make sure all visualization features are available you need to install additional software. Take a look at visualization page to read more about installation and usage of these software and visualizing molecules using Ångström.

Tests

Unit tests are available using pytest. You can run the tests by executing pytest in the main repository. There will be warnings and that's expected but if you would like to suppress them you can use pytest --disable-pytest-warnings.