TSP Specification¶
The formal TSP (TSL Structure Package) specification is maintained as part of the tslstructures R package.
Full Specification¶
The complete specification document is available at:
tslstructures TSP Specification
This includes: - Required and optional files - JSON Schema for datapackage.json - Parquet column definitions - Validation requirements - Version compatibility
Quick Reference¶
Required Files¶
| File | Format | Purpose |
|---|---|---|
datapackage.json |
JSON | Package manifest |
metadata.parquet |
Parquet | Structure index |
structures/batch_*.tar.gz |
tar.gz | Structure files |
predictions/scores.parquet |
Parquet | Confidence scores |
Optional Files¶
| File | Format | Purpose |
|---|---|---|
predictions/pae/batch_*.tar.gz |
tar.gz | PAE matrices |
foldseek/ |
Directory | Pre-computed search database |
Current Version¶
TSP Version: 1.0.0
The version is recorded in datapackage.json as the tsp_version field.
Validation¶
Use tslstructures to validate a TSP package:
library(tslstructures)
result <- validate_tsp("/path/to/my-dataset")
if (result$valid) {
message("Package is valid!")
message("Structures: ", result$stats$structure_count)
} else {
message("Validation failed:")
print(result$errors)
}
Related Documentation¶
- TSP Format - Package structure overview
- Creating Datasets - Build TSP packages