Welcome¶
This documentation serves as a comprehensive guide for developers who aspire to contribute to the Tudat project. Whether you’re setting up your development environment or diving into the intricacies of the codebase, this is your starting point.
Introduction¶
Welcome, Developers! This platform is designed to equip you with all the necessary information to contribute effectively to the Tudat project. It includes guidelines for setting up your development environment, building the Tudat project, and contributing code.
Getting Started¶
If you’re new to Tudat or are setting up your development environment for the first time, start here. This section provides a primer on the essential topics you need to understand before you dive into the codebase.
How-to guides¶
For those looking for more advanced or specific information, the Guides section dives deeper into particular topics. Whether you’re trying to understand specific workflows or looking for best practices, this is the place for you.
How-to Guides
- Create a Conda Feedstock
- Create Hybrid C++/Python modules in
tudatpy - Define Azure Environment Variables
- Define Program Environment Variables
- Exposing C++ to Python
- Exposing Kernel Modules in
tudatpy - Generate Anaconda Cloud Access Tokens
- Generate GitHub Access Tokens
- Version Package Releases
- Write docstrings for
tudatandtudatpy
Explanation¶
The Explanation section provides in-depth understanding and context for key concepts and mechanisms. It aims to clarify the ‘why’ behind various features and processes, offering a comprehensive background to help you grasp the underlying principles and rationale.
Explanation
Todo
CI/CD pipeline and its components
Reference¶
For an organized and detailed look at Tudat’s codebase, the Reference section has you covered. It provides comprehensive information about the classes, functions, and variables that make up the project.
Reference