Installation Guide
Requirements
Ngawari requires Python 3.9 or higher and the following dependencies:
Installation Methods
From PyPI (Recommended)
The easiest way to install Ngawari is using pip:
pip install ngawari
From Source
To install from the source code:
git clone https://github.com/fraser29/ngawari.git
cd ngawari
pip install -e .
Development Installation
For development work, install with documentation dependencies:
pip install -e .[docs]
This will install additional packages needed for building documentation:
sphinx - Documentation generator
sphinx-rtd-theme - Read the Docs theme
sphinx-autodoc-typehints - Type hints support
myst-parser - Markdown support
Verifying Installation
After installation, you can verify that Ngawari is working correctly:
from ngawari import ftk, fIO, vtkfilters
# Create a simple test
sphere = vtkfilters.buildSphereSource([0, 0, 0], radius=1.0)
print(f"Sphere created with {sphere.GetNumberOfPoints()} points")
# Test array operations
points = vtkfilters.getPtsAsNumpy(sphere)
print(f"Points shape: {points.shape}")
Version Compatibility
Ngawari is tested with: * Python 3.9, 3.10, 3.11 * VTK 9.3.0 and later * NumPy 1.21 and later * SciPy 1.7 and later
If you encounter compatibility issues, please check the GitHub issues or create a new one.