Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,67 @@ authors:
given-names: "Eric"
affiliation: "Sorbonne Université, Institut du Cerveau - Paris Brain Institute - ICM, Inserm U1127, CNRS UMR 7225, AP-HP, Paris, France; Lyon Neuroscience Research Center (CRNL), INSERM U1028, CNRS UMR 5292, Université Claude Bernard Lyon 1, Lyon, France"
orcid: "https://orcid.org/0000-0002-9690-5909"
preferred-citation:
type: article
title: "Open-BEATBox: an open-source autonomous operant chamber for high-throughput data acquisition of complex behaviour"
journal: "bioRxiv"
year: 2026
notes: "Preprint DOI to be added when posted"
authors:
- family-names: "Euvrard"
given-names: "Marine"
affiliation: "Sorbonne Université, Institut du Cerveau - Paris Brain Institute - ICM, Inserm U1127, CNRS UMR 7225, AP-HP, Paris, France"
- family-names: "Benzina"
given-names: "Nabil"
affiliation: "Sorbonne Université, Institut du Cerveau - Paris Brain Institute - ICM, Inserm U1127, CNRS UMR 7225, AP-HP, Paris, France"
orcid: "https://orcid.org/0000-0001-9761-8955"
- family-names: "Domingues"
given-names: "Daniela"
affiliation: "Sorbonne Université, Institut du Cerveau - Paris Brain Institute - ICM, Inserm U1127, CNRS UMR 7225, AP-HP, Paris, France; Lyon Neuroscience Research Center (CRNL), INSERM U1028, CNRS UMR 5292, Université Claude Bernard Lyon 1, Lyon, France"
orcid: "https://orcid.org/0009-0001-8046-1696"
- family-names: "Mondragón-González"
given-names: "Sirenia Lizbeth"
affiliation: "Sorbonne Université, Institut du Cerveau - Paris Brain Institute - ICM, Inserm U1127, CNRS UMR 7225, AP-HP, Paris, France; Lyon Neuroscience Research Center (CRNL), INSERM U1028, CNRS UMR 5292, Université Claude Bernard Lyon 1, Lyon, France"
orcid: "https://orcid.org/0000-0002-9036-7257"
- family-names: "Huzard"
given-names: "Damien"
affiliation: "Neuronautix, Montpellier, France"
orcid: "https://orcid.org/0000-0003-4820-7951"
- family-names: "Penderia"
given-names: "Guillaume"
affiliation: "Sorbonne Université, Institut du Cerveau - Paris Brain Institute - ICM, Inserm U1127, CNRS UMR 7225, AP-HP, Paris, France"
- family-names: "Travert-Jouanneau"
given-names: "Youenn"
affiliation: "Sorbonne Université, Institut du Cerveau - Paris Brain Institute - ICM, Inserm U1127, CNRS UMR 7225, AP-HP, Paris, France"
- family-names: "Lavielle"
given-names: "Oriana"
affiliation: "Sorbonne Université, Institut du Cerveau - Paris Brain Institute - ICM, Inserm U1127, CNRS UMR 7225, AP-HP, Paris, France"
- family-names: "Lousada"
given-names: "Eliana"
affiliation: "Sorbonne Université, Institut du Cerveau - Paris Brain Institute - ICM, Inserm U1127, CNRS UMR 7225, AP-HP, Paris, France"
- family-names: "Schreiweis"
given-names: "Christiane"
affiliation: "Sorbonne Université, Institut du Cerveau - Paris Brain Institute - ICM, Inserm U1127, CNRS UMR 7225, AP-HP, Paris, France; Lyon Neuroscience Research Center (CRNL), INSERM U1028, CNRS UMR 5292, Université Claude Bernard Lyon 1, Lyon, France"
orcid: "https://orcid.org/0000-0002-8523-9445"
- family-names: "Lorenz"
given-names: "Anne"
affiliation: "Sorbonne Université, Institut du Cerveau - Paris Brain Institute - ICM, Inserm U1127, CNRS UMR 7225, AP-HP, Paris, France"
- family-names: "Pavlov"
given-names: "Pierre"
affiliation: "Sorbonne Université, Institut du Cerveau - Paris Brain Institute - ICM, Inserm U1127, CNRS UMR 7225, AP-HP, Paris, France"
- family-names: "Ajili"
given-names: "Zenneddine"
affiliation: "Sorbonne Université, Institut du Cerveau - Paris Brain Institute - ICM, Inserm U1127, CNRS UMR 7225, AP-HP, Paris, France"
- family-names: "Lebegue"
given-names: "Lucile"
affiliation: "Sorbonne Université, Institut du Cerveau - Paris Brain Institute - ICM, Inserm U1127, CNRS UMR 7225, AP-HP, Paris, France"
- family-names: "Tissier"
given-names: "Pierre"
affiliation: "Sorbonne Université, Institut du Cerveau - Paris Brain Institute - ICM, Inserm U1127, CNRS UMR 7225, AP-HP, Paris, France"
- family-names: "Burguière"
given-names: "Eric"
affiliation: "Sorbonne Université, Institut du Cerveau - Paris Brain Institute - ICM, Inserm U1127, CNRS UMR 7225, AP-HP, Paris, France; Lyon Neuroscience Research Center (CRNL), INSERM U1028, CNRS UMR 5292, Université Claude Bernard Lyon 1, Lyon, France"
orcid: "https://orcid.org/0000-0002-9690-5909"
repository-code: "https://github.com/Open-BeatBox/Open-BeatBox.github.io"
url: "https://open-beatbox.github.io/"
license: AGPL-3.0-or-later
Expand Down
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@ You do **not** need to be a programmer. You do need basic hand tools, and **some

Open-BEATBox is published as several repositories, one per layer, each under the licence that fits it.

The MATLAB/Arduino implementation and the analysis code used for the behavioural data in the preprint are being prepared for publication and are not yet public.

| Layer | Repository | What you will find | Licence |
| --- | --- | --- | --- |
| **Website** *(this repository)* | [Open-BeatBox.github.io](https://github.com/Open-BeatBox/Open-BeatBox.github.io) | The public website; the pipeline that builds and publishes the manual | AGPL-3.0 |
Expand Down Expand Up @@ -192,7 +194,22 @@ Each repository carries its own `LICENSE` file, which is authoritative for that

## Citing Open-BEATBox

Each repository has a `CITATION.cff` file, so GitHub's **Cite this repository** button gives you APA and BibTeX. A reference paper is in preparation; once it is published it will become the preferred citation.
If you use Open-BEATBox in published work, please cite **both** the reference preprint and the archived release of the layer you used.

**The platform (preprint):**

> Euvrard M, Benzina N, Domingues D, Mondragón-González SL, Huzard D, Penderia G, Travert-Jouanneau Y, Lavielle O, Lousada E, Schreiweis C, Lorenz A, Pavlov P, Ajili Z, Lebegue L, Tissier P, Burguière E. "Open-BEATBox: an open-source autonomous operant chamber for high-throughput data acquisition of complex behaviour." bioRxiv, 2026 (DOI to be added when the preprint is posted).

**The release you used (Zenodo record):**

| Layer | Repository | Release | Zenodo DOI |
| --- | --- | --- | --- |
| Hardware | [Open-BeatBox_Hardware](https://github.com/Open-BeatBox/Open-BeatBox_Hardware/releases) | `biorxiv-v1` | DOI: to be added once release `biorxiv-v1` is published on Zenodo |
| Software (PC application and firmware) | [Open-BeatBox_Software](https://github.com/Open-BeatBox/Open-BeatBox_Software/releases) | `biorxiv-v1` | DOI: to be added once release `biorxiv-v1` is published on Zenodo |
| Documentation (manual, tutorials, BOM) | [Open-BeatBox_Documentation](https://github.com/Open-BeatBox/Open-BeatBox_Documentation/releases) | `biorxiv-v1` | DOI: to be added once release `biorxiv-v1` is published on Zenodo |
| Firmware | [Open-BeatBox_Firmware](https://github.com/Open-BeatBox/Open-BeatBox_Firmware) | — | No record of its own: the firmware is in the Software repository, cite that record |

Each repository also has a `CITATION.cff` file, so GitHub's **Cite this repository** button gives you APA and BibTeX. Once the preprint is posted, it becomes the preferred citation in every citation file.

## Contributing

Expand Down
2 changes: 1 addition & 1 deletion resources/build-guides/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Build guides have moved

The assembly tutorials and the Master BOM are in **[assembly-tutorials](https://github.com/Open-BeatBox/assembly-tutorials)**. The build guide that ties them together is part of the manual, in **[Open-BeatBox_Documentation](https://github.com/Open-BeatBox/Open-BeatBox_Documentation)** (CC-BY-4.0).
The assembly tutorials and the Master BOM are in the **[Open-BeatBox_Documentation](https://github.com/Open-BeatBox/Open-BeatBox_Documentation)** repository (CC-BY-4.0), under `source/build/assembly-tutorials`. The Master BOM is published at <https://open-beatbox.github.io/docs/manual/build/bom.html>. The former `assembly-tutorials` repository is archived.

The rendered manual is at <https://open-beatbox.github.io/docs/manual/>, and the build guide at <https://open-beatbox.github.io/docs/manual/build/index.html>.
8 changes: 6 additions & 2 deletions site/content/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,13 @@ sections:
- type: "text"
title: "How to cite Open-BEATBox"
body: |
If you use Open-BEATBox in a scientific publication, please cite the project. Each repository carries a `CITATION.cff` file, so GitHub's **Cite this repository** button gives you APA and BibTeX directly.
If you use Open-BEATBox in a scientific publication, please cite **both** the reference preprint and the archived release of the layer you used.

A reference paper is in preparation. Once it is published it becomes the preferred citation, and the citation files will be updated to point at it.
**The platform (preprint):** Euvrard M, Benzina N, Domingues D, Mondragón-González SL, Huzard D, Penderia G, Travert-Jouanneau Y, Lavielle O, Lousada E, Schreiweis C, Lorenz A, Pavlov P, Ajili Z, Lebegue L, Tissier P, Burguière E. "Open-BEATBox: an open-source autonomous operant chamber for high-throughput data acquisition of complex behaviour." bioRxiv, 2026 (DOI to be added when the preprint is posted).

**The release you used:** each release of the [Hardware](https://github.com/Open-BeatBox/Open-BeatBox_Hardware/releases), [Software](https://github.com/Open-BeatBox/Open-BeatBox_Software/releases) and [Documentation](https://github.com/Open-BeatBox/Open-BeatBox_Documentation/releases) repositories is archived on Zenodo with its own DOI (release `biorxiv-v1` for the preprint; DOI: to be added once release `biorxiv-v1` is published on Zenodo). The firmware has no record of its own: it is part of the Software repository, so cite that record.

Each repository carries a `CITATION.cff` file, so GitHub's **Cite this repository** button gives you APA and BibTeX directly.
- type: "list"
title: "Tutorials"
items:
Expand Down
6 changes: 4 additions & 2 deletions site/src/components/Footer.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import React from "react";
import Link from "next/link";
import "./Footer.css";

type Props = {
Expand All @@ -17,8 +18,9 @@ const Footer: React.FC<Props> = ({ title, description }) => {
<div className="footer-links flex gap-4 text-sm">
<a href="https://open-beatbox.github.io/docs/manual/">Documentation</a>
<a href="https://open-beatbox.github.io/docs/manual/build/">Build your own</a>
<a href="https://github.com/Open-BeatBox/Open-BeatBox_Software">GUI</a>
<a href="https://github.com/Open-BeatBox/Open-BeatBox.github.io">Github</a>
<a href="https://github.com/Open-BeatBox/Open-BeatBox_Software">Software</a>
<a href="https://github.com/Open-BeatBox">GitHub</a>
<Link href="/community">How to cite</Link>
</div>
</div>
<p className="footer-credits">
Expand Down
Loading