Welcome to SciStream Documentation
This documentation provides an overview of SciStream, guides for users and developers, and information about authentication and security.
Table of Contents
- Introduction
- Understanding SciStream
- Installation
- Quickstart
- User Guide
- Authentication and Security
- Developer Guide
- Tutorials
- Troubleshooting
About SciStream
SciStream is a security framework enabling high-speed data streaming between scientific instruments and high-performance computing (HPC) facilities. It securely allows participating facilities to make their resources available through a programmatic interface. The framework enables:
- End-to-end encrypted data transfer between instruments and HPC resources
- Zero-trust security model with strong authentication and authorization
- Flexible deployment options across institutions and environments
- Fine-grained access controls for scientific data
Documentation Structure
Core Concepts
- Introduction - Overview of SciStream and its purpose
- Understanding SciStream - Architecture and components
Getting Started
- Installation - Set up SciStream in your environment
- Quickstart - Get up and running quickly
Guides
- User Guide - Using SciStream
- Authentication - Security and access control
- Developer Guide - Extending and developing SciStream
- Tutorials - Step-by-step examples
Reference
- Changelog - Version history and updates
- FAQ - Frequently asked questions
- Troubleshooting - Common issues and solutions
Getting Help
If you need further assistance or have any questions: - Create an issue on GitHub - Check the Troubleshooting Guide - Join our community discussions