Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add reference to glossary terms #18

Merged
merged 1 commit into from
Apr 17, 2024
Merged
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
22 changes: 13 additions & 9 deletions src/reference/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,35 @@

This glossary provides definitions for terms used throughout the project documentation.

:::{glossary}

Aeon
: The source of all being [^1]
The source of all being. [^1]

Session
: For experiment 0.1, the event over the time period when an animal is placed in the nesting cage until the time the animal is removed from the nesting cage.
For experiment 0.1, the event over the time period when an animal is placed in the nesting cage until the time the animal is removed from the nesting cage.

Trial
: For experiment 0.1, the event over the time period when an animal starts moving the wheel on a patch until the time a pellet is delivered. Every experiment 0.1 session ends on incompleted trials.
For experiment 0.1, the event over the time period when an animal starts moving the wheel on a patch until the time a pellet is delivered. Every experiment 0.1 {term}`session` ends on incompleted trials.

Acquisition Epoch
: The event over the time period when the acquistion computer is on and acquiring data until it is stopped. For experiment 0.1 there are multiple acquisition runs due to Bonsai/Windows being restarted.
The event over the time period when the acquistion computer is on and acquiring data until it is stopped. For experiment 0.1 there are multiple acquisition runs due to Bonsai/Windows being restarted.

Acquisition Chunk Duration
: The time duration over which datastream files are written out. For experiment 0.1, datastreams were written out in files of 1 hour chunk durations.
The time duration over which datastream files are written out. For experiment 0.1, datastreams were written out in files of 1 hour chunk durations.

Acquisition Chunk
: The event (i.e. all data) over a particular acquisition chunk duration.
The event (i.e. all data) over a particular {term}`acquisition chunk duration`.

Acquisition Slice Duration
: The minimum time resolution a user can get from an initial query of a Datajoint table (the timebin size of BLOB and QC data stored in Datajoint tables). For experiment 0.1 this was 10 minutes.
The minimum time resolution a user can get from an initial query of a Datajoint table (the timebin size of BLOB and QC data stored in Datajoint tables). For experiment 0.1 this was 10 minutes.

Acquisition Slice
: The event (i.e. all data) over a particular acquisition slice duration.
The event (i.e. all data) over a particular {term}`acquisition slice duration`.

Task Protocol
: An integer number and associated string describing a unique behavioral task run in Project Aeon. For experiment 0.1, there were 8 unique behavioral tasks run.
An integer number and associated string describing a unique behavioral task run in Project Aeon. For experiment 0.1, there were 8 unique behavioral tasks run.

:::

[^1]: https://en.wikipedia.org/wiki/Aeon_(Gnosticism)
Loading