Skip to content

Commit

Permalink
flesh out index.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
NickleDave committed Dec 23, 2018
1 parent 395083b commit e9113b1
Showing 1 changed file with 41 additions and 2 deletions.
43 changes: 41 additions & 2 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,53 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Crowsetta's documentation!
=====================================
Crowsetta
=========

.. toctree::
:maxdepth: 2
:caption: Contents:

Crowsetta is a tool to ~~conbirt~~ work with any format for annotating birdsong.
**The goal of `crowsetta` is to make sure that your ability to work with a dataset
of annotated birdsong does not depend on your ability to work with any given format for
annotating that dataset. `crowsetta` does not to provide yet another format
for annotating birdsong!** (I promise.)

from crowsetta import Crowsetta
crow = Crowsetta(extra_config=your_config_info)
crow.to_csv(file_'your_annotation_file.mat', csv_filename='your_annotation.csv')

Features
--------

- convert annotation formats to Sequence objects that can be easily used in a Python program
- convert Sequences to comma-separated value text files that can be read on any system
- load comma-separated values files back into Python and convert to other formats

Installation
------------

Install `crowsetta` by running:

$ pip install crowsetta

Contribute
----------

- Issue Tracker: github.com/NickleDave/crowsetta/issues
- Source Code: github.com/NickleDave/crowsetta

Support
-------

If you are having issues, please let us know.
- Issue Tracker: github.com/NickleDave/crowsetta/issues

License
-------

The project is licensed under the BSD license.

Indices and tables
==================
Expand Down

0 comments on commit e9113b1

Please sign in to comment.