Skip to content

Commit

Permalink
Updated installation instructions in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AndrewHerzing committed Apr 16, 2024
1 parent d1c6575 commit 5de521f
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,28 +11,29 @@ Installation

Anaconda (Preferred):
---------------------
* The required packages can be installed into an existing Anaconda environmnent.
Install major dependencies Astra Toolbox and HyperSpy. Optional but highly recommended,
ipympl should also be installed to enable interactive plotting in Jupyter Lab.
* Install major dependencies Astra Toolbox and HyperSpy.

# NOTE: `astra-toolbox` must be installed first due to a dependency conflict.
```bash
conda create -n tomo
conda activate tomo
conda install -c astra-toolbox astra-toolbox
conda install -c conda-forge hyperspy
conda update --all
conda install -c conda-forge hyperspy-base hyperspy-gui-ipywidgets
```

* Install the TomoTools package from GitHub:
```bash
pip install git+https://github.com/usnistgov/tomotools.git
```

# OPTIONAL: install `ipympl` and to enable interactive plotting in Jupyter
```bash
conda install -c conda-forge ipympl
```
Optional (higly recommended):
---------------------
* Install `ipympl` and `ipykernel` to use `tomotools` with Jupyter.
* `ipympl` enables interactive plotting in Jupyter Lab or Notebook.
* `ipykernel` allows use of the the tomoools kernel with Jupyter installed in a different environment.

```bash
conda install ipympl ipykernel
```

Removal
-------
Expand Down

0 comments on commit 5de521f

Please sign in to comment.