Skip to content

Installation

Requirements

  • Python 3.10 or higher
  • pip (Python package installer)

Install from PyPI

The recommended way to install GridGulp is from PyPI:

pip install gridgulp

Install from Source

To install the latest development version from GitHub:

pip install git+https://github.com/Ganymede-Bio/gridgulp.git

Or clone the repository and install locally:

git clone https://github.com/Ganymede-Bio/gridgulp.git
cd gridgulp
pip install -e .

Optional Dependencies

Development Tools

To contribute to GridGulp or run tests, install the development dependencies:

pip install gridgulp[dev]

This includes: - pytest for testing - ruff for linting - mypy for type checking - pre-commit hooks

Documentation

To build the documentation locally:

pip install gridgulp[docs]
mkdocs serve

Verify Installation

After installation, verify that GridGulp is working:

import gridgulp
print(gridgulp.__version__)

Or from the command line:

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

Troubleshooting

ImportError: No module named 'magic'

GridGulp uses python-magic for file type detection. On some systems, you may need to install additional system dependencies:

macOS: 

brew install libmagic

Ubuntu/Debian: 

sudo apt-get install libmagic1

Windows: The Python package includes the necessary DLLs, but if you encounter issues, see the python-magic documentation.

Next Steps