Installation

Mamba

The easiest way to install lipyphilic is using mamba and the conda-forge channel of Conda:

mamba create -n lipyphilic -c mamba-forge python=3.11 lipyphilic
mamba activate lipyphilic

This will install lipyphilic along with all of its dependencies into a new virtual environment.

If you do not already have Mamba installed on your machine, we recommend downloading and installing Miniforge.

PyPI

It’s also possible to install lipyphilic from the Python Package Index. You can do this using pip:

python -m pip install lipyphilic

Alternatively, you can also install the in-development version with:

python -m pip install https://github.com/p-j-smith/lipyphilic/archive/main.zip

Dependencies

lipyphilic uses MDAnalysis to carry out all analysis calculations, and Freud for performing Voronoi tessellations.

As mentioned above, the simplest way to install these packages, along with lipyphilic, is with Conda. However, it is also possible to install MDAnalysis and Freud using pip, or from source. See the MDAnalysis and Freud installation instructions for further information.