Contributing¶
Thank you for your interest in contributing to Generalized ADCS!
This project is a research-grade simulation framework for spacecraft attitude determination and control (ADCS). We welcome contributions from students, researchers, and industry engineers with interests in spacecraft dynamics, estimation, and control.
🧭 Ways to Contribute¶
There are many ways you can help improve the project, including:
🧠 Developing new controllers (e.g., LQR, MPC, adaptive control)
📡 Adding new sensor models (star trackers, sun sensors, gyroscopes, magnetometers)
🔁 Implementing new estimators (EKF, UKF, particle filters)
🎮 Creating new simulation scenarios or benchmark cases
🧪 Expanding testing and validation coverage
📖 Improving or extending documentation
🐛 Fixing bugs and optimizing performance
🖼 Enhancing visualization and animation tools
🛠 Development Setup¶
Instructions for setting up the development environment are provided here:
Please follow these instructions to ensure your environment matches the project requirements before contributing.
✅ Testing & Documentation¶
When submitting new features or making significant changes, please ensure that the following requirements are met:
✅ Appropriate test cases are added or updated in the
testing/directory✅ All existing tests continue to pass
✅ The Sphinx documentation builds successfully
Additional guidance can be found here:
🛠 Sphinx Build Guide
⚙️ Testing Guide