Installation

Requirements

TreeScape requires Python 3.9 or higher and the following dependencies:

  • caliper-reader

  • ipython

  • llnl-hatchet

  • llnl-thicket

  • matplotlib

  • numpy

  • pandas

  • jupyterlab

Installing from Source

  1. Clone the repository:

git clone https://github.com/LLNL/treescape.git
cd treescape

  1. Create a virtual environment:

python3 -m venv venv

  1. Activate the virtual environment:

On Linux/macOS:

source venv/bin/activate

On Windows:

venv\Scripts\activate

  1. Install the dependencies:

pip install -r requirements.txt

  1. Run Jupyter Lab:

jupyter lab

Verifying Installation

To verify that TreeScape is installed correctly, open a Python interpreter and try:

import treescape as ts
print(ts.__file__)

This should print the path to the TreeScape installation directory without errors.

Development Installation

For development, you may want to install in editable mode:

pip install -e .

This allows you to modify the source code without reinstalling the package.