Show it on your project

Citing COMPAS in your publications and marking the projects you build with it show where the work comes from, and help make the case for maintaining it.

Cite COMPAS

Writing a paper? Cite the software through its DOI, 10.5281/zenodo.2594510. It is a concept DOI on Zenodo, so it always resolves to the latest release.

Van Mele, T., Casas, G., Kasirer, C., Rust, R., et al. COMPAS [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.2594510

@software{compas,
  author    = {Van Mele, Tom and Casas, Gonzalo and Kasirer, Chen and Rust, Romana and others},
  title     = {{COMPAS}},
  publisher = {Zenodo},
  doi       = {10.5281/zenodo.2594510},
  url       = {https://doi.org/10.5281/zenodo.2594510}
}

If you use an extension package, such as COMPAS FAB or COMPAS Timber, check its documentation for its own citation as well.

Add the badge

Put the badge in your README to mark your repository as made with COMPAS. Paste your repository below: the badge links to its page in Mission Control, the COMPAS ecosystem dashboard.

GitHub repository

Without a repository, the badge links to the Mission Control overview.

StandardFlat

MarkdownreStructuredTextHTML

[![Made with COMPAS](https://compas.dev/badge.svg)](https://compas.dev/mission-control/)

Copy

Add your project to the showcase

Built something with COMPAS? Submit your project to appear in Made with COMPAS. Submissions are reviewed before they are published.