Skip to content

Commit

Permalink
add logo and update links to new name (#57)
Browse files Browse the repository at this point in the history
* add logo, update some links
  • Loading branch information
MaHaWo authored Jul 18, 2024
1 parent 2dcd633 commit c510b3b
Show file tree
Hide file tree
Showing 7 changed files with 100 additions and 13 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[![tests](https://github.com/ssciwr/iSparrow/actions/workflows/main.yml/badge.svg?event=push)](https://github.com/ssciwr/iSparrow/actions/workflows/main.yml)
[![codecov](https://codecov.io/gh/ssciwr/iSparrow/graph/badge.svg?token=FwyE0PNiOk)](https://codecov.io/gh/ssciwr/iSparrow)
[![tests](https://github.com/ssciwr/faunanet/actions/workflows/main.yml/badge.svg?event=push)](https://github.com/ssciwr/faunanet/actions/workflows/main.yml)
[![codecov](https://codecov.io/gh/ssciwr/faunanet/graph/badge.svg?token=FwyE0PNiOk)](https://codecov.io/gh/ssciwr/faunanet)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=ssciwr_iSparrow&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=ssciwr_iSparrow)
[![Supported OS: Linux | macOS | Windows](https://img.shields.io/badge/OS-Linux%20%7C%20macOS%20%7C%20Windows-green.svg)](https://www.linux.org/)
[![Documentation](https://readthedocs.org/projects/isparrow/badge/?version=latest)](https://isparrow.readthedocs.io/en/latest/?badge=latest)
[![Documentation](https://readthedocs.org/projects/isparrow/badge/?version=latest)](https://isparrow.readthedocs.io/en/latest/index.html)
[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

# faunanet - A bioacoustics platform based on birdnetlib using neural networks
# ![Logo](faunanet_logo_small.png) faunanet - A bioacoustics platform based on birdnetlib using neural networks
## What is faunanet?
`faunanet` is an extension of [*Birdnet-Analyzer*](https://github.com/kahst/BirdNET-Analyzer), and uses [*birdnetlib*](https://github.com/joeweiss/birdnetlib) as its basis.
`faunanet` was developed with the goal to provide a platform for bioacoustics research projects, started at the Interdisciplinary center for scientific computing at the University of Heidelberg.
Expand All @@ -24,10 +24,10 @@ By extending elements of bridnetlib rather, `faunanet` conserves the latter's ca
Please refer to the 'Getting faunanet up and running' section in the documentation for an introduction.

## Bugs, issues and feature requests
Please use the [issue tab of the github page](https://github.com/ssciwr/iSparrow/issues) to report any bugs or feature requests.
Please use the [issue tab of the github page](https://github.com/ssciwr/faunanet/issues) to report any bugs or feature requests.

## Contributions
Feel free to contribute to this project by opening a pull request [here](https://github.com/ssciwr/iSparrow/pulls).
Feel free to contribute to this project by opening a pull request [here](https://github.com/ssciwr/faunanet/pulls).

## Usage
### Installation
Expand Down Expand Up @@ -56,7 +56,7 @@ You can also install it from source to get the latest development chagnes. To do
```bash
cd path/to/dir/where/faunanet/should/live

git clone https://github.com/ssciwr/iSparrow.git
git clone https://github.com/ssciwr/faunanet.git

python3 -m venv ./path/to/faunanet/venv

Expand Down
4 changes: 2 additions & 2 deletions doc/source/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ cd path/to/where/repo/should/go
```
- clone the repository:
```bash
git clone [email protected]:ssciwr/iSparrow.git # for using https: https://github.com/ssciwr/iSparrow.git
git clone [email protected]:ssciwr/faunanet.git # for using https: https://github.com/ssciwr/faunanet.git
```
- make a new python virtual environment and activate it
```bash
Expand Down Expand Up @@ -149,4 +149,4 @@ The easiest way to provide your own model to use with `faunanet` is to retrain t
You can also change the model on the fly via the `change_analyzer` command. This command works almost identically to the `start` command. See the documentation of the REPL {doc}`repl_usage` for more.

## Contribution
Issue- or bug reports and feature requests as well as code contributions are welcome here: https://github.com/ssciwr/iSparrow
Issue- or bug reports and feature requests as well as code contributions are welcome here: https://github.com/ssciwr/faunanet
4 changes: 2 additions & 2 deletions doc/source/readme_doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ By extending elements of bridnetlib rather, `faunanet` conserves the latter's ca
Please refer to the 'Getting faunanet up and running' section in the documentation for an introduction.

## Bugs, issues and feature requests
Please use the [issue tab of the github page](https://github.com/ssciwr/iSparrow/issues) to report any bugs or feature requests.
Please use the [issue tab of the github page](https://github.com/ssciwr/faunanet/issues) to report any bugs or feature requests.

## Contributions
Feel free to contribute to this project by opening a pull request [here](https://github.com/ssciwr/iSparrow/pulls).
Feel free to contribute to this project by opening a pull request [here](https://github.com/ssciwr/faunanet/pulls).
Binary file added faunanet_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit c510b3b

Please sign in to comment.