Installation
============

This page describes how to install swctools from GitHub and how to set up a development environment.

Requirements
------------

- Python >= 3.12 (per ``pyproject.toml``)
- OS: Windows/macOS/Linux

Install from GitHub (latest main)
---------------------------------

.. code-block:: bash

   pip install "git+https://github.com/jmrfox/swctools.git"

Development setup with uv
--------------------------

.. code-block:: bash

   # Create and activate a virtual environment
   uv venv

   # Editable install with dev extras (linting, tests, docs)
   uv pip install -e .[dev]

   # Run tests
   uv run pytest -q

   # Serve documentation locally (Sphinx)
   uv run sphinx-build -b html docs docs/_build/html

Jupyter usage
-------------

If you plan to use notebooks, ensure a kernel is available in your env. One option:

.. code-block:: bash

   pip install ipykernel
   python -m ipykernel install --user --name swctools --display-name "Python (swctools)"

Then in a notebook:

.. code-block:: python

   from swctools import SWCModel, FrustaSet, plot_model

Uninstall
---------

.. code-block:: bash

   pip uninstall swctools