Scatterkit Documentation¶
This documentation covers everything you need to know about Scatterkit. There are five sections:
If you are new to Scatterkit, we recommend starting with the Getting started section.
Getting started¶
The Getting started section is for Scatterkit beginners. It will help you install and familiarize yourself with Scatterkit and its approach to analyse molecular dynamics simulations.
How-to guides¶
The How-to guides section is for Scatterkit intermediate and advanced users. It contains guides taking you through series of steps involved in addressing key problems and special use-cases in Scatterkit.
Analysis Modules¶
The Analysis modules section is for Scatterkit for intermediate users, it contains technical references and parameter list for each Scatterkit module. Even more advanced API documentation of all underlying functions and classes is described in API documentation.
API Documentation¶
The API documentation section is for Scatterkit for advanced users, it contains technical references and parameter list for the APIs behind the library. It describes the various functionalities provided by Scatterkit. You can always refer to this section to learn more about classes, functions, modules, and other aspects of Scatterkit machinery you may come across behind the analysis classes described in Analysis modules.
Concepts & Explanations¶
The Concepts & explanations section discusses key topics and concepts at a fairly high level and provides explanations to expand your knowledge of Scatterkit. It requires at least basic to intermediate knowledge of Scatterkit.