Sirius

Sirius has willingly been developped by CS as an Open Source software. As so, we believe this documentation shall not only explain how to use it, but also explain the algorithms behind it. It should be noticed the used of the word ‘algorithms’ instead of ‘theory’ here. We believe that the theory can merely be found on the internet with high quality courses and documentations, and so will only sparsely point at it. However, we thought to begin with, and now know for sure, that the hardest part is rather knowing how to comprehend its discretization and deal with its outcomes. Hence this is what we will be focusing on in this documentation:

• 1. Sirius at a glance
  • 1.1. Overview
  • 1.2. Docker App
  • 1.3. How to Build
  • 1.4. How to use
  • 1.5. Unit tests
  • 1.6. Acknowledgement
• 2. Sirius Theoretical Basis
  • 2.1. Upsampling
  • 2.2. Downsampling
  • 2.3. References
  • 2.4. Associated Python Code
• 3. Sirius Developer Zone
  • 3.1. Class Hierarchy
  • 3.2. File Hierarchy
  • 3.3. Full API