chirpdetector

An algorithm to detect the chirps of weakly electric fish.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: github_username, repo_name, twitter_handle, linkedin_username, email_client, email, project_title, project_description

(back to top)

 .
├──  2022-06-02-10_00
│  ├──  2022.06.02_0.mp4
│  ├──  analysis
│  │  ├──  baseline_freq_times.npy
│  │  ├──  baseline_freqs.npy
│  │  ├──  fish_freq.npy
│  │  ├──  fish_freq_interp.npy
│  │  ├──  frame_times.npy
│  │  ├──  rise_idx.npy
│  │  └──  rise_size.npy
│  ├──  backup
│  │  ├──  fund_v.npy
│  │  ├──  ident_v.npy
│  │  ├──  idx_v.npy
│  │  ├──  meta.npy
│  │  ├──  sign_v.npy
│  │  ├──  spec.npy
│  │  └──  times.npy
│  ├──  chirp_ids.npy
│  ├──  chirps.npy
│  ├──  chirps_ids.npy
│  ├──  fill_freqs.npy
│  ├──  fill_spec.npy
│  ├──  fill_spec_shape.npy
│  ├──  fill_times.npy
│  ├──  fishgrid.cfg
│  ├──  fund_v.npy
│  ├──  ident_v.npy
│  ├──  idx_v.npy
│  ├──  LED_frames.npy
│  ├──  led_idxs.csv
│  ├──  led_times.csv
│  ├──  LED_val.npy
│  ├──  meta.npy
│  ├──  sign_v.npy
│  ├──  spec.npy
│  ├──  times.npy
│  └──  traces-grid1.raw
└──  mount_data

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Installation

1. Get a free API Key at https://example.com
2. Clone the repo

   git clone https://github.com/github_username/repo_name.git
   

3. Install NPM packages

   npm install
   

4. Enter your API in config.js

   const API_KEY = 'ENTER YOUR API';
   

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Feature 1
• Feature 2
• Feature 3
  • Nested Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contact

Your Name - @twitter_handle - email@email_client.com

Project Link: https://github.com/github_username/repo_name

(back to top)

Acknowledgments

(back to top)