Skip to content

Latest commit

 

History

History
85 lines (55 loc) · 2.24 KB

README.md

File metadata and controls

85 lines (55 loc) · 2.24 KB
Raw

Atoman - analysis and visualisation of atomistic simulations

License and copying

Developed by Chris Scott
Copyright 2015 Loughborough University
Released under the MIT license, see "LICENSE.md" for details.

Dependencies

This code requires Python 3 and depends on a number of Python libraries, a C and C++ compiler (ideally one that supports OpenMP - tested with gcc and g++) and also some other optional software.

Python modules

This list of required modules can be found in "requirements.txt" and installed, for example, using pip:

pip install -r requirements.txt

Other software

In order to be able to use all features the following programmes should be installed:

  • POV-Ray (for offline rendering of images; looks better)
  • Ffmpeg (for creating movies; sequencer and rotator)

If these are not installed in default system locations you can set the paths to where they are installed in the preferences dialog in the GUI.

Installation

You can either build the code in-place or install the Python package, for example within a virtualenv.

In both cases you should first copy the config file: cp setup.cfg.example setup.cfg and add/edit any relevant sections. There are some comments in the file to help with selecting the options.

You need to choose one of the following two methods for installing the software.

In-place build

Build the C extensions in-place:

python setup.py build_ext -i

Verify the tests run with no errors:

python setup.py test

Then you can add the /path/to/Atoman directory to you PYTHONPATH and run python -m atoman from anywhere to run the software.

Install the Python package

Build the C extensions in-place:

python setup.py build_ext -i

Verify the tests run with no errors:

python setup.py test

Install the package:

python setup.py build
python setup.py install

If you are not using a virtual environment you may need to sudo the last (install) command.

Following this you should be able to run python -m atoman from anywhere to run the software. Alternatively you could use the Atoman command to run the software.