SHRED-X Documentation

This package houses SHRED models for research and industrial purposes.

Getting started

New to SHRED? Check out the Getting Started Guide. It contains an introduction to using the package and how to get started.

To the Getting Started guide

Tutorials

The Tutorials are a collection of notebooks that demonstrate how to use the package.

To the Tutorials

API

The API is the core components of the framework. It is the interface that allows the user to use the package.

To the API

Contributing

Want to add to the codebase? The Contributing guide will guide you through the process of adding to the package.

To the Contributing guide