Downloading and Installation¶
Prerequisites¶
The current version of Sitka Spruce is 0.3, released in July, 2026.
This is first release, development is still active. This version is suitable for testing but may not be ready for production use. Comments and suggestions are welcome.
Sitka Spruce requires Python 3.11 or higher, wxPython 4.2.4 or higher, matplotlib 3.10 or higher, numpy 2.3 or higher. For HDF5, both the h5py 3.13 and the hdf5plugin are required. For Zarr files, zarr 3.2 or higher is required.
All of the required dependencies are available from pip or on conda channels.
As an important note is that wxPython is required. This package is available on PyPI for MacOS and Windows. For Linux, the libraries that wxPython itself needs are not always pre-installed, and not easily bundled in the PyPI package. This is then a good reason for using an Anaconda Python environment, which provides wxPython amd its needed binary libraries through its conda-forge repository.
Installation¶
For Python installations that have a working wxPython package, the latest version (0.3) is available from PyPI and can be installed with:
pip install sitka-spruce
To install into a new environment in an existing Anaconda Python installation, use
conda create -y --name sitka python>=3.13
conda activate sitka
conda install -y -c conda-forge numpy scipy matplotlib h5py>=3.13 wxpython>=4.2.4
pip install sitka-spruce
sitka -m
To install a fresh, stand-alone Anaconda Python installation with Sitka, use
curl -O https://raw.githubusercontent.com/xraypy/sitka-spruce/master/installers/GetSitka.sh
sh GetSitka.sh
Development Version¶
The latest development version, can be cloned with:
git clone https://github.com/xraypy/sitka-spruce.git
Installation from Source¶
Sitka Spruce is a pure python module, so installation on all platforms can use the source kit and a standard installation using:
python -m pip install .
Creating the Desktop Shortcut¶
Once installed, a desktop shortcut to launch the Sitka application can be created with:
sitka -m
If the Python environment with sitka-spruce installed is not in your system PATH, you may need to find the sitka program, either in the “bin” folder with the appropriate “python” program on macOS or Linux, or in the “Scripts” folder of your Python environment on Windows.
License¶
The source code and documentation for Sitka Source are distributed under the following license:
MIT License
Copyright (c) 2026 Matthew Newville, The University of Chicago
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
