Skip to content
This repository has been archived by the owner on Feb 13, 2022. It is now read-only.

FATSLiM/fatslim

Repository files navigation

FATSLiM

Important Note

This repository is archived!

I do not work on MD simulations of lipid membranes anymore and do not have time to work on FATSLiM.

I encourage users to switch to similar (yet mainained) tools like e.g. LiPyphilic.

About

FATSLiM means "Fast Analysis Toolbox for Simulation of Lipid Membranes". As you can imagine, the goal is to provide 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/.

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