.. _projects:

Projects Using daolite
=======================

This page showcases research projects, observatories, and instruments that use daolite for adaptive optics timing analysis and system design.

If you're using daolite in your project, please let us know! You can submit a pull request to add your project here, or contact the maintainers.

.. _citing_daolite:

Citing daolite
--------------

If you use daolite in your research or project, please cite:

**BibTeX:**

.. code-block:: bibtex

   @software{david_2025_17342890,
     author       = {David, Barr},
     title        = {davetbarr/daolite: v0.1.0 - First Public Alpha},
     month        = oct,
     year         = 2025,
     publisher    = {Zenodo},
     version      = {v0.1.0},
     doi          = {10.5281/zenodo.17342890},
     url          = {https://doi.org/10.5281/zenodo.17342890},
   }

**APA:**

   David, B. (2025). davetbarr/daolite: v0.1.0 - First Public Alpha (v0.1.0). Zenodo. https://doi.org/10.5281/zenodo.17342890

**DOI Badge:**

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.17342890.svg
   :target: https://doi.org/10.5281/zenodo.17342890
   :alt: DOI

Academic Publications
---------------------

Publications that have used daolite for AO system design or analysis:

.. note::
   
   Publications using daolite will be listed here. If you have published work using daolite, 
   please submit a pull request or contact the maintainers to have it added.

*No publications listed yet.*

Research Projects
-----------------

Projects and observatories using daolite:

.. _project_example:

Example Project Name
~~~~~~~~~~~~~~~~~~~~

.. note::
   
   This is a placeholder. Add your project information here.

**Project**: [Project Name]

**Institution**: [Institution/Observatory]

**Description**: Brief description of how daolite was used in the project.

**Publications**: 
   - Author et al. (2024). "Title". *Journal*, vol(issue), pages. DOI: xxx

**Links**:
   - Project website: [URL]
   - GitHub: [URL]
   - Documentation: [URL]

----

Durham AO RTC Systems
~~~~~~~~~~~~~~~~~~~~~

**Project**: Durham Adaptive Optics Real-Time Control Systems

**Institution**: Durham University, Centre for Advanced Instrumentation

**Description**: daolite was developed at Durham University to support the design and optimization of real-time control systems for adaptive optics. It has been used to model timing for various RTC implementations targeting both SCAO and MCAO systems.

**Links**:
   - Durham AO: [URL to be added]
   - Centre for Advanced Instrumentation: https://www.dur.ac.uk/cfi/

----

Contributing Your Project
-------------------------

To add your project to this list:

1. **Fork the repository** on GitHub
2. **Edit this file** (``docs/source/projects.rst``)
3. **Add your project** following the template above
4. **Submit a pull request** with a brief description

Include the following information:

- **Project name** and institution/observatory
- **Brief description** of how daolite is used
- **Publications** (if applicable) with DOI links
- **Links** to project website, code repositories, or documentation

Template
~~~~~~~~

Use this template to add your project:

.. code-block:: rst

   Project Name
   ~~~~~~~~~~~~
   
   **Project**: [Full Project Name]
   
   **Institution**: [Institution/Observatory Name]
   
   **Description**: [How daolite is used - 2-3 sentences]
   
   **Publications**: 
      - Author et al. (YEAR). "Title". *Journal*, vol(issue), pages. DOI: xxx
   
   **Links**:
      - Project website: [URL]
      - GitHub: [URL]
      - Documentation: [URL]
   
   ----

Community Guidelines
--------------------

When adding your project:

- **Be concise**: Keep descriptions brief and informative
- **Provide links**: Include relevant URLs for more information
- **Update publications**: Add papers as they are published
- **Attribution**: Properly cite daolite using the BibTeX entry above
- **Contact information**: Consider including a contact email for collaboration

Questions?
----------

If you have questions about adding your project or need help with citations, please:

- Open an issue on GitHub: https://github.com/durhamAO/daolite/issues
- Contact the maintainers through the repository

We look forward to seeing how daolite helps your AO projects!