Skip to content

Commit

Permalink
Features list into README
Browse files Browse the repository at this point in the history
  • Loading branch information
ajjackson committed Feb 8, 2016
1 parent 1d8b72a commit 57636c8
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,18 @@ Please use the [issue tracker](https://github.com/ajjackson/ascii-phonons/issues

![](images/comof_phonon.gif)

## Features

* Import atomic positions, unit cell and phonon modes from `.ascii` files
* Use open-source graphics package Blender to render images; the end-user is not required to interact with the Blender GUI unless they want to
* Create static or animated images showing the unit cell bounding box, atomic positions and mass-weighted eigenvectors
* Use ImageMagick to export .gif files for use in web browser
* Display arbitrary supercell size defined by three counting numbers. The displayed bounding box may be shifted within this structure.
* Animated images include mass-weighted movements of atoms, which include the phase shift in different unit cells
* Arrows indicating mass-weighted eigenvectors do *not* include phase information
* An attractive "cartoon-like" visual style with flat colours and outlines
* Atom colours are assigned from a default or user config file. If undefined, a random colour is selected.

## Development

The target for input files is the ASCII format used by [v_sim](http://inac.cea.fr/L_Sim/V_Sim/), a useful program and currently one of the only tools available for visualising phonons. These files contain all the information needed to define a crystal sructure and its vibrations. It is presumed that these are generated by [Phonopy](http://phonopy.sourceforge.net/) from *ab initio* electronic structure calculations, and initially this code will only target the features used by Phonopy. Extension to the full ASCII format is of course welcome.
Expand Down

0 comments on commit 57636c8

Please sign in to comment.