Installation

Python Requirements

m3-download requires Python 3.10 or later.

Install directly from GitHub

SSH Key Required

Ensure you have a working SSH key for GitHub. If you don't have one, you can follow the instructions here.

You can install the latest version directly from the GitHub repository using:

pip install git+ssh://git@github.com/mbari-org/m3-download.git

Install from local repository

Alternatively, if you prefer to clone the repository first:

# Clone the repository
git clone git@github.com:mbari-org/m3-download.git
cd m3-download

# Install using pip
pip install -e .

Development Mode

The -e flag installs the package in "editable" mode, which is useful for development. Changes to the source code will be immediately available without reinstalling.

Test the installation

To verify that the installation was successful, you can run the following command:

m3-download --help

Success Indicator

This should display the help message for the m3-download command-line tool, indicating that it is installed and ready to use.

Dependencies

The installation will automatically handle all required dependencies through pip. If you encounter any dependency issues, ensure your pip is up to date with:

pip install --upgrade pip