Installation#

To install HoloSpy, you have the following options (independent of the operating system you use):

  1. HoloSpy is included in the HyperSpy Bundle, a standalone program that includes a python distribution and all relevant libraries (recommended if you do not use python for anything else).

  2. Installation using conda (recommended if you are also working with other python packages).

  3. Installation using pip.

  4. Installing the development version from GitHub. Refer to the appropriate section in the HyperSpy user guide (replacing hyperspy by holospy).

Installation using conda#

Follow these 3 steps to install HoloSpy using conda and start using it.

1. Creating a conda environment#

HoloSpy requires Python 3 and conda – we suggest using the Python 3 version of Miniforge.

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

  1. Load the miniforge prompt.

  2. Run the following command:

(base) conda create -n holospy -y

2. Installing the package in the new environment#

Now activate the holospy environment and install the package from conda-forge:

(base) conda activate holospy
(holospy) conda install -c conda-forge holospy -y

Required dependencies will be installed automatically.

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

Note

If you run into trouble, check the more detailed documentation in the HyperSpy user guide.

3. Getting Started#

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

(base) conda activate holospy
(holospy) conda install -c conda-forge jupyterlab -y
(holospy) jupyter lab

Installation using pip#

Alternatively, you can also find HoloSpy in the Python Package Index (PyPI) and install it using (requires pip):

pip install holospy

Required dependencies will be installed automatically.

Updating the package#

Using conda:

conda update holospy -c conda-forge

Using pip:

pip install holospy --upgrade

Note

If you want to be notified about new releases, please Watch (Releases only) the HoloSpy repository on GitHub (requires a GitHub account).

On this page
Show Source