Skip to content

Commit

Permalink
DOC: Add logo in doc/index.md
Browse files Browse the repository at this point in the history
borrowing grid layout from sphinx-book-theme docs
  • Loading branch information
NickleDave committed Jun 24, 2022
1 parent 73ef2e3 commit b8a4a13
Showing 1 changed file with 31 additions and 10 deletions.
41 changes: 31 additions & 10 deletions doc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,42 @@ execution:
timeout: 120
---

# crowsetta
::::{grid}
:reverse:
:gutter: 2 1 1 1
:margin: 4 4 1 1

crowsetta is a Python tool to work with any format for annotating
animal vocalizations and other bioacoustics data.
Many of these formats are for files created
by GUI-based apps that enable users to annotate audio and/or spectrograms.
Annotations include the times when sound events start and stop,
:::{grid-item}
:columns: 8
:class: sd-fs-3

A Python tool to work with any format for annotating
animal vocalizations and bioacoustics data.
:::

:::{grid-item}
:columns: 4

```{image} ./_static/crowsetta-secondary-logo.png
:width: 150px
```
:::

::::

crowsetta provides a Pythonic way to work with annotation formats
for animal vocalizations and bioacoustics data.
These formats are used, for example, by
applications that enable users to annotate audio and/or spectrograms.
Such annotations typically include the times when sound events start and stop,
and labels that assign each sound to some set of classes
chosen by the annotator.
crowsetta has built-in support for many widely used {ref}`formats <formats-index>`
such as {ref}`Audacity label tracks <aud-txt>`,
{ref}`Praat .TextGrid files <textgrid>`,
and {ref}`Raven .txt files <raven>`.

```{figure} _static/example-textgrid-for-index.png
:::{figure} _static/example-textgrid-for-index.png
---
width: 90%
figclass: margin-caption
Expand All @@ -42,9 +63,9 @@ Example song from
[Bengalese finch song dataset](https://osf.io/r6paq/),
Tachibana and Morita 2021, adapated under
CC-By-4.0 License.**
```
:::

```{figure} _static/example-raven-for-index.png
:::{figure} _static/example-raven-for-index.png
---
width: 90%
figclass: margin-caption
Expand All @@ -60,7 +81,7 @@ Example song from
["An annotated set of audio recordings of Eastern North American birds containing frequency, time, and species information"](https://esajournals.onlinelibrary.wiley.com/doi/full/10.1002/ecy.3329),
Chronister et al., 2021, adapated under
CC0 1.0 License.**
```
:::

Who would want to use crowsetta?
Anyone that works with animal vocalizations
Expand Down

0 comments on commit b8a4a13

Please sign in to comment.