Installation¶

From PyPI¶

The recommended way to install numgrids is via pip:

pip install numgrids

To upgrade to the latest release:

pip install --upgrade numgrids

For development or to use the latest unreleased code, clone the repository and install in editable mode:

git clone https://github.com/maroba/numgrids.git
cd numgrids
pip install -e .

numgrids requires Python 3.10 or later and depends on the following packages (installed automatically by pip):

Package	Minimum version	Purpose
numpy	>= 1.22	Array operations and meshgrid generation
scipy	>= 1.10.1	Sparse matrices, interpolation, linear algebra
matplotlib	>= 3.5	Axis and grid visualization
findiff	>= 0.10	Finite-difference stencil generation

Note

All four dependencies are pure-Python wheels on most platforms, so installation typically requires no compiler.

After installing, confirm that numgrids is importable and check the installed version:

python -c "import numgrids; print(numgrids.__version__)"

You should see output like:

0.4.0

Tip

If you are working in a virtual environment (recommended), make sure it is activated before running pip install.