Skip to content

yueguangzoum/Sire

 
 

Repository files navigation

** `Sire <http://siremol.org>`__**

About

Sire is a free, open source, multiscale molecular simulation framework, written to allow computational modellers to quickly prototype and develop new algorithms for molecular simulation and molecular design. Sire is written as a collection of libraries, each of which contains self-contained and robust C++/Python building blocks. These building blocks are vectorised and thread-aware and can be streamed (saved/loaded) to and from a version-controlled and tagged binary format, thereby allowing them to be combined together easily to build custom multi-processor molecular simulation applications.

For more information about how to use Sire, and about application built with Sire, please visit the Sire website.

Installation

There are many pre-built binary packages, which are available for Linux, Mac OS X and Windows, which are quick and easy to install.

However, as you are here, it is likely you want to download the latest, greatest version of the code, which you will need to compile. To compile Sire, you need a working C++ compiler with at least C++ 2014 support (gcc >= 5 or clang >= 3.7), cmake (version 3.0.0 or above), a Git client to download the source, and a working internet connection (needed by the Sire compilation scripts to download additional dependencies).

The easy install option is:

git clone git@github.com:michellab/Sire.git
cd Sire
./compile_sire.sh

A small word of warning, the compilation can easily take over an hour!

The above will download and install a new miniconda python installation, into which Sire will be compiled and deployed (together with its dependencies). This is by far the easiest way to compile and install Sire, and is the route we strongly recommend. If you have any problems with compiling and installing Sire, then please get in touch using the links below.

If you want to install Sire into an existing miniconda or Anaconda Python installation, please follow the instructions in build/INSTALL_INTO_ANACONDA.rst.

Support and Development

Bugs, Comments, Questions

For bug reports/sugguestions/complains please file an issue on GitHub. or contact the developers via the google user group: https://groups.google.com/forum/#!forum/sire-users

Developers guide

Please visit the website for information on how to develop applications using Sire.

Travis -- Autobuild feature

Since Sire is quite large, a build can take quite long and might not be neccessary if a commit is only fixing a couple of typos. Simply add the line [ci skip] to your commit message and Travis will not invoke an autobuild.

Have fun :-)

About

Sire Molecular Simulations Framework

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C++ 93.3%
  • Python 4.2%
  • Fortran 1.1%
  • CMake 0.9%
  • C 0.4%
  • Shell 0.1%