Installation

Follow these 3 steps to install LumiSpy.

Creating a conda environment

LumiSpy requires Python 3 and conda – we suggest using the Python 3 version of Miniconda.

We recommend creating a new environment for the LumiSpy package (or installing it in the HyperSpy environment, if you have one already). To create a new environment:

  1. Load the anaconda prompt.

  2. Run the following command:

(base) conda create -n lumispy

Installing the package in the new environment

Now activate the LumiSpy environment and install the package using pip:

(base) conda activate lumispy
(lumispy) pip install lumispy

Installation is completed! To start using it, check the next section.

Getting Started

To get started using LumiSpy, especially if you are unfamiliar with Python, we recommend using Jupyter notebooks. Having installed LumiSpy as above, a Jupyter notebook can be opened using the following commands entered into an anaconda prompt (from scratch):

(base) conda activate lumispy
(lumispy) jupyter lab