Installation

dfg-tool requires Python 3.10 or later; see python.org/downloads.

Installing from source

Ensure you have set up an SSH key with GitHub, then to install or upgrade dfg-tool from source, run:

pip install --upgrade git+ssh://git@github.com/mbari-org/dfg-tool.git

Alternatively, you can clone the repository and install from there:

git clone git@github.com:mbari-org/dfg-tool.git
cd dfg-tool
pip install .

Installing for development

dfg-tool uses uv for dependency management. Install uv via the uv installation docs.

To install dfg-tool in editable mode with all development dependencies:

uv sync --all-groups

To run commands within the managed environment:

uv run dfg --help