sunxspex Documentation¶
Everything you need to know about sunxspex.
How the documentation is organized¶
The sunxspex documentation is divided into four sections a high-level overview of its organisation will help you know where to look for certain things:
Tutorials take you by the hand through a series of steps to create fit an X-ray spectrum.
Topic guides discuss key topics and concepts at a fairly high level and provide useful background information and explanation.
Reference guides contain technical reference for APIs and other aspects of sunxspex machinery. They describe how it works and how to use it but assume that you have a basic understanding of key concepts.
How-to guides are recipes. They guide you through the steps involved in addressing key problems and use-cases. They are more advanced than tutorials and assume some knowledge of how sunxspex works.