Skip to content

Latest commit

 

History

History
78 lines (47 loc) · 3.39 KB

README.md

File metadata and controls

78 lines (47 loc) · 3.39 KB
Raw

CROW - Online tool to visualize birds detected by weather radars

DOI Run tests and deploy to GitHub pages if successful

CROW is a single-page application to visualize birds detected by weather radars. It visualizes vpts data from a public repository directly in the browser and can thus be hosted on a static file server. As it only visualizes data from one radar at a time, it is easily scalable.

CROW is implemented in TypeScript and makes use of the Vue CLI toolkit, D3 and BootstrapVue.

CROW was jointly developed by the Research Institute for Nature and Forest (INBO) and the Royal Meteorological Institute of Belgium (RMI) in collaboration with the Royal Belgian Institute for Natural Sciences (RBINS), with financial support from the Belgian Science Policy Office (BelSPO valorisation project CROW).

The application can be cited as:

Noé N, Reyniers M, Van Hoey S, Desmet P (2021) CROW - Online tool to visualize birds detected by weather radars. http://doi.org/10.5281/zenodo.4629449

Running installations

⚠️ About this fork

This fork is created for aloftdata.eu.

Making changes

  • Only commit changes in this fork (aloft/crow) that are specific to the Aloft deployment. Here are all the changes specific to this fork. Don't merge those changes into the main repo.
  • Changes that are beneficial to the main app (bug fixes, dependency updates, improvements) should be made in the main repo (inbo/crow).
  • Use Sync fork to pull changes from the main repo.

Where are the data?

This is defined in the aloftBaltradUrl variable in src/config.ts. The application pulls data from s3://aloftdata (browse the data here). It expects the data to formatted as daily VPTS CSV file (vptsFileFormat: "CSV").

How to update radars?

Radar metadata are hardcoded in src/config.ts.

Installation and deployment

Install with:

npm install

Run in development with:

npm run serve

Run unit tests with:

npm run test:unit

Build with:

npm run build

There is no need to build manually, as this is done automatically by GitHub Actions for every commit pushed to the main branch. It will serve the site at https://enram.github.io/crow/.

If the app is to be deployed under a URL prefix (for example https://inbo.github.io/crow), create a env.local file in the source tree root with content: URL_PREFIX = "/crow/".

Architecture and data flow

See src/README.md.

License

MIT License