Skip to content

Installation

For Data Producers (Python)

Prerequisites

  • Python 3.10 or later
  • pip package manager

Install tsp-maker

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

Verify Installation

tsp-maker --version
tsp-maker --help

Dependencies

tsp-maker automatically installs: - numpy - pyarrow - requests - click

For Data Consumers (R)

Prerequisites

  • R 4.0 or later
  • Recommended: RStudio

Install tslstructures

Using pak (recommended): 

# Install pak if you don't have it
install.packages("pak")

# Install tslstructures
pak::pak("TeamMacLean/tslstructures")

Using remotes: 

install.packages("remotes")
remotes::install_github("TeamMacLean/tslstructures")

Verify Installation

library(tslstructures)

# Check version
packageVersion("tslstructures")

# List available datasets (requires internet)
list_datasets(sandbox = TRUE)

Dependencies

tslstructures automatically installs: - arrow (for parquet files) - httr2 (for Zenodo API) - cli (for user messages) - dplyr, tibble (for data manipulation)

For Both

If you're both creating and consuming datasets, install both tools:

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

# R
pak::pak("TeamMacLean/tslstructures")

Zenodo Account

To upload datasets, you'll need a Zenodo account:

  1. Create an account at zenodo.org
  2. Generate an API token:
  3. Go to Account → Applications → Personal access tokens
  4. Create a token with scopes: deposit:write, deposit:actions
  5. Keep your token secure (never commit to git)

For testing, use sandbox.zenodo.org which has separate accounts and non-permanent DOIs.

Further Reading