Skip to content

Latest commit

 

History

History
58 lines (41 loc) · 1.81 KB

INSTALLATION.md

File metadata and controls

58 lines (41 loc) · 1.81 KB

Installation

1) 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:
    $ conda create -n lumispy

2) Installing the package in the new environment

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

    $ conda activate lumispy
    $ pip install lumispy

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

OPTIONAL: Working with eV instead of wavelength units

In order to convert your signal luminescence axes (normally in wavelength in nanometers) to energy units, you will need to reinstall the hyperspy package to its developing branch RELEASE_next_minor. If you skip this, all LumiSpy functions will work, except the energy conversion.

To do that, follow these steps:

  1. Load the anaconda prompt.
  2. Activate the LumiSpy environment using conda activate lumispy).
  3. Install git and reinstall the HyperSpy package running:
    $ conda activate lumispy
    $ conda install git -y
    $ pip uninstall hyperspy -y
    $ pip install git+git://github.com/hyperspy/hyperspy@RELEASE_next_minor

Now you are ready to use all the functionalites of LumiSpy.

3) 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):

    $ conda activate lumispy
    $ jupyter lab