Skip to content

Installation

Requirements

  • Python 3.9 or higher
  • pip

Install from GitHub

pip install git+https://github.com/TeamMacLean/tsp-maker.git

Install for Development

git clone https://github.com/TeamMacLean/tsp-maker.git
cd tsp-maker
pip install -e ".[dev]"

Verify Installation

tsp-maker --version

Dependencies

tsp-maker automatically installs these dependencies:

Package Purpose
numpy Array operations for PAE matrices
pyarrow Parquet file I/O
requests Zenodo API communication
click Command-line interface

Zenodo Setup

To upload datasets to Zenodo, you'll need an API token:

  1. Create a Zenodo account at zenodo.org (or sandbox.zenodo.org for testing)
  2. Go to SettingsApplicationsPersonal access tokens
  3. Create a new token with deposit:write scope
  4. Save the token securely

Use the Sandbox First

Always test uploads on sandbox.zenodo.org before using production Zenodo. Sandbox uploads don't create real DOIs.

Set the token as an environment variable:

# For sandbox (testing)
export ZENODO_SANDBOX_TOKEN="your-sandbox-token"

# For production
export ZENODO_TOKEN="your-production-token"