Singularity

This repository contains tools, scripts, and guides for Singularity, a data preparation and Filecoin onboarding application.

Goal & Purpose

The purpose of this repository is to provide resources to help users deploy Singularity and manage data onboarding workflows. These utilities are intended to assist with preparing data for Filecoin storage.

Contents

Guides

• Preserving Open Science Data with Singularity and Docker: A guide covering Singularity deployment using Docker and Docker Compose.

Utilities & Tools

• CID Comparison Tool: A containerized environment for comparing CID generation between IPFS (Kubo) and Singularity.
• Retrieval Review: A Python toolkit for checking the retrieval status of unsealed content from storage providers.
• Docker Deployment: The Dockerfile and docker-compose files referenced in the guides.

Scripts

A suite of scripts for specific use cases:

• Piece Download Automation: Automates the download of pieces from a Singularity preparation.
• Metadata Export: Exports metadata on the deal status of piece CIDs for preparations.
• Deal Size Summarizer: Summarizes the total size of Filecoin deals.

Getting Started

The Step-by-Step Guide provides instructions for deploying using the provided Docker utilities.

---