Installation#

\(\mathrm{LiMe}\) can be installed via pip. The following commands install \(\mathrm{LiMe}\) either on its own or along with all its dependencies:

pip install lime-stable  
pip install lime-stable[full]

Warning

Depending on the terminal shell language, you may need to use quotes in the command with the dependencies:

pip install "lime-stable[full]"

Core Dependencies#

The following packages are essential for \(\mathrm{LiMe}\)’s operation:

  • Numpy – Array operations

  • Pandas – Table management and reading tabulated files

  • Matplotlib – Default plotting library

  • LmFit – Fitting library

  • Astropy – Loading and saving .fits files

  • scipy – Scientific algorithms

  • tomli – Reading .toml files for Python < 3.11

Optional Dependencies#

The following packages enable optional features but are not required:

  • asdf – Save measurements as .asdf files

  • bokeh – Plots using the Bokeh library

  • mplcursors – Interactive pop-ups in plots

  • openpyxl – Save measurements as .xlsx files

  • PyLaTeX – Save measurements as .pdf files

  • toml – Save configuration files as .toml

Updating LiMe#

To upgrade to the latest version:

pip install lime-stable --upgrade

Uninstalling or Changing Versions#

To uninstall \(\mathrm{LiMe}\):

pip uninstall lime-stable

To install a specific version:

pip install lime-stable==1.4

For Developers#

The following command installs all dependencies required to compile the documentation and run tests:

pip install lime-stable[full,docs,tests]

LiMe v2.0 has been tested with Python 3.12. See the pyproject.toml on GitHub for the most up-to-date build and dependency information.