@@ -29,15 +29,47 @@ A Streamlit web app for **validating** bird species detections made by [BirdNET]
2929
3030## 🚀 Getting Started
3131
32- ### Option A: Python package (recommended)
32+ ### Option A: One-line install (recommended)
3333
34- Install directly from GitHub — no config files needed:
34+ > ** Never used Python before? No problem!** Follow the steps below.
35+
36+ #### Step 1: Install Python
37+
38+ Download and install Python from [ python.org] ( https://www.python.org/downloads/ ) (version 3.10 or newer).
39+
40+ - ** Windows:** Download the installer, run it, and ** check the box "Add Python to PATH"** before clicking Install
41+ - ** Mac:** Download the macOS installer and follow the prompts
42+ - ** Linux:** Python is usually pre-installed. Check with ` python3 --version `
43+
44+ #### Step 2: Install the app
45+
46+ Open a terminal (or Command Prompt on Windows) and run:
3547
3648``` bash
3749pip install git+https://github.com/NINAnor/birdnetValidator.git
3850```
3951
40- Then in Python:
52+ This installs everything you need. It may take a minute or two.
53+
54+ #### Step 3: Launch!
55+
56+ In the same terminal, run:
57+
58+ ``` bash
59+ birdnet-validator \
60+ --audio-dir /path/to/your/audio \
61+ --results-dir /path/to/your/birdnet/results \
62+ --output-dir /path/to/your/output
63+ ```
64+
65+ Replace the paths with your actual directories. The app opens in your browser automatically. 🎉
66+
67+ > ** Windows tip:** Use backslashes in paths and put the whole command on one line:
68+ > ```
69+ > birdnet-validator --audio-dir C:\Users\me\audio --results-dir C:\Users\me\results --output-dir C:\Users\me\output
70+ > ```
71+
72+ You can also use it from a Python script:
4173
4274```python
4375import birdnet_validator
@@ -49,17 +81,6 @@ birdnet_validator.run(
4981)
5082```
5183
52- This opens the app in your browser automatically. That's it! 🎉
53-
54- Or from the command line:
55-
56- ``` bash
57- birdnet-validator \
58- --audio-dir /path/to/audio \
59- --results-dir /path/to/results \
60- --output-dir /path/to/output
61- ```
62-
6384<details >
6485<summary >☁️ Using S3 paths? (click to expand)</summary >
6586
@@ -90,31 +111,7 @@ birdnet-validator \
90111
91112</details >
92113
93- ### Option B: R package
94-
95- Install directly from GitHub — Python dependencies are handled automatically:
96-
97- ``` r
98- remotes :: install_github(" NINAnor/birdnetValidator" , subdir = " r-package" )
99- ```
100-
101- Then:
102-
103- ``` r
104- library(birdnetValidator )
105-
106- run_validator(
107- audio_dir = " /path/to/audio" ,
108- results_dir = " /path/to/results" ,
109- output_dir = " /path/to/output"
110- )
111- ```
112-
113- The first call sets up a Python environment behind the scenes. Subsequent calls start instantly.
114-
115- > ** Note:** Python (>= 3.10) must be installed on your system. You can download it from [ python.org] ( https://www.python.org/downloads/ ) . The R package handles everything else (virtual environment, Python dependencies).
116-
117- ### Option C: From source (for developers)
114+ ### Option B: From source (for developers)
118115
119116``` bash
120117git clone https://github.com/NINAnor/birdnetValidator.git
0 commit comments