Installation
This guide covers how to install the site_analysis package.
Requirements
site_analysis requires Python 3.12 or later.
Installing from PyPI
The recommended way to install site_analysis is via pip:
pip install site-analysis
This will automatically install all required dependencies.
Optional Dependencies
For faster polyhedral site analysis and distance calculations, you can install with numba acceleration:
pip install site-analysis[fast]
This enables JIT-compiled containment testing, which makes per-frame analysis of the argyrodite tutorial trajectory with polyhedral sites about three times faster, with identical results. It also speeds up the minimum-image distance calculations used throughout the package.
Installing from Source
For development or to access the latest features before release, you can install directly from the source code:
Clone the repository:
git clone https://github.com/bjmorgan/site-analysis.git cd site-analysis
Install in development mode:
pip install -e .
The -e flag installs the package in editable mode, meaning changes to the source code will be reflected in your environment without reinstalling.
Verifying Installation
To verify that site_analysis installed correctly, you can import it in Python:
import site_analysis
If no errors occur, the installation was successful.
Development Installation
If you plan to contribute to site_analysis, you may want to install additional development dependencies:
pip install -e ".[dev]"
This includes packages needed for testing and building documentation.