https://github.com/pyronear/pyro-crowdsourcer
Crowdsourcing of labeled images of wildfires
https://github.com/pyronear/pyro-crowdsourcer
computer-vision crowdsourcing streamlit wildfire
Last synced: 2 months ago
JSON representation
Crowdsourcing of labeled images of wildfires
- Host: GitHub
- URL: https://github.com/pyronear/pyro-crowdsourcer
- Owner: pyronear
- License: apache-2.0
- Created: 2022-01-09T17:57:57.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-27T22:19:10.000Z (over 2 years ago)
- Last Synced: 2024-10-29T13:16:48.912Z (7 months ago)
- Topics: computer-vision, crowdsourcing, streamlit, wildfire
- Language: Python
- Homepage: https://pyro-crowdsourcer.herokuapp.com/
- Size: 65.4 KB
- Stars: 1
- Watchers: 4
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](LICENSE)  [](https://www.codacy.com/gh/pyronear/pyro-crowdsourcer/dashboard?utm_source=github.com&utm_medium=referral&utm_content=pyronear/pyro-crowdsourcer&utm_campaign=Badge_Grade) [](https://www.codefactor.io/repository/github/pyronear/pyro-crowdsourcer)
The image crowdsourcing platform for wildfire visual data.
## Quick Tour
### Running/stopping the service
You can run the platform as a container using this command:
```shell
make run
```
You can now navigate to `http://localhost:8050` to interact with the platform.
In order to stop the service, run:
```shell
make stop
```
## Installation
### Prerequisites
- [Docker](https://docs.docker.com/engine/install/)
- [Docker compose](https://docs.docker.com/compose/)
- [Make](https://www.gnu.org/software/make/) (optional)
The project was designed so that everything runs with Docker orchestration (standalone virtual environment) that will run itself the [Dash](https://plotly.com/dash/) interface, so you won't need to install any additional libraries.
## Configuration
In order to run the project, you will need to specific some information, which can be done using a `.env` file.
This file will have to hold the following information:
- `API_URL`: the endpoint URL of your [pyro-storage](https://github.com/pyronear/pyro-storage) instance
- `API_LOGIN`: the login for your API access
- `API_PWD`: the password for your API access
So your `.env` file should look like something similar to:
```
API_URL='https://replace.with.your.api.endpoint/'
API_LOGIN=my_dummy_login
API_PWD=my_dummy_password
```
The file should be placed at the root folder of your local copy of the project.
## Contributing
If you scrolled down to this section, you most likely appreciate open source. Do you feel like helping with unresolved issues? Or perhaps submitting a new feature idea? Or contributing in any other way?
You're in luck, we compiled a short guide (cf. [`CONTRIBUTING`](CONTRIBUTING.md)) for you to easily do so!
## License
Distributed under the Apache 2.0 License. See [`LICENSE`](LICENSE) for more information.