======= 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 "\ F\ ast \ A\ nalysis \ T\ oolbox for \ S\ imulation of \ Li\ pid \ M\ embranes". 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

Master branch_:

.. image:: https://travis-ci.com/FATSLiM/fatslim.svg?branch=master :target: https://travis-ci.com/FATSLiM/fatslim

.. image:: https://coveralls.io/repos/github/FATSLiM/fatslim/badge.svg?branch=master :target: https://coveralls.io/github/FATSLiM/fatslim?branch=master

Develop branch_:

.. image:: https://travis-ci.com/FATSLiM/fatslim.svg?branch=develop :target: https://travis-ci.com/FATSLiM/fatslim

.. image:: https://coveralls.io/repos/github/FATSLiM/fatslim/badge.svg?branch=develop :target: https://coveralls.io/github/FATSLiM/fatslim?branch=develop

Installation

FATSLiM can be installed using pip via the following command:

.. code::

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:

.. code::

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

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

.. code::

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:

.. code::

fatslim self-test

Documentation

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

.. _FATSLiM: http://fatslim.github.io/ .. license: https://github.com/FATSLiM/fatslim/blob/master/LICENSE .. develop branch: https://github.com/FATSLiM/fatslim/tree/develop .. master branch: https://github.com/FATSLiM/fatslim/tree/master .. http://pythonhosted.org/fatslim: http://pythonhosted.org/fatslim .. MDAnalysis: https://www.mdanalysis.org/ .. Jupyter: https://jupyter.org/ .. _LiPyphilic: https://pubs.acs.org/doi/10.1021/acs.jctc.1c00447