Skip to content

Floriy/fatslim

 
 

Repository files navigation

FATSLiM

FATSLiM means "Fast Analysis Toolbox for Simulation of Lipid Membranes". As you can imagine, the goal is to provide ~~the Ultimate Question of Life, the Universe, and Everything~~ a fast and efficient tool to extract membrane-related physical properties from Molecular Dynamics simulations of lipid bilayers. To see what FATSLiM is able to do, please visit the homepage at http://fatslim.github.io/.

Important Note

FATSLiM is currently undergoing a major rewrite (read it is rewritten from scratch) in progress to overcome some intrinsic limitations. The major goals of this rewrite are:

  • To use MDAnalysis`_ as a backend for trajectory and topology files I/O.
  • To provide an external API to use FATSLiM as a library so it can be use in e.g. Jupyter notebooks.
  • To ease code maintainability.

Please check out the full-rewrite branch to follow the progression.

Status

https://travis-ci.com/FATSLiM/fatslim.svg?branch=master https://coveralls.io/repos/github/FATSLiM/fatslim/badge.svg?branch=master https://travis-ci.com/FATSLiM/fatslim.svg?branch=develop https://coveralls.io/repos/github/FATSLiM/fatslim/badge.svg?branch=develop

Installation

FATSLiM can be installed using pip via the following command:

pip install fatslim

Alternatively, installation can be done directly from source code which is hosted in a git repository at https://github.com/FATSLiM/fatslim and is available under the GNU General Public License, version 3 (see license). You can then clone the repo:

git clone https://github.com/FATSLiM/fatslim.git

And then compile and install using the usual setup.py:

cd fatslim/
python setup.py install

Finally, it is always a good idea to run the self-test command to make sure that everything is OK:

fatslim self-test

Documentation

A full documentation is available at: http://pythonhosted.org/fatslim

About

Main code repository for FATSLiM

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 79.0%
  • C 19.5%
  • Shell 1.5%