diff --git a/README.md b/README.md index 2b98c9b..ef807df 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,50 @@ # 3lips -Coordinate registration for multi-static radar + +Coordinate registration for multi-static radar using ellipse intersections. Not a dating app. + +## Features + +- Provides a JSON API for geolocation of targets given [blah2](http://github.com/30hours/blah2) radar nodes. +- Uses a [CesiumJS](http://github.com/CesiumGS/cesium) web front-end to visualise data. +- Ability to compare a number of algorithms for coordinate registration. + +## Usage + +- Install docker and docker-compose on the host machine. +- Clone this repository to some directory. +- Run the docker compose command. + +‘’’ +sudo git clone http://github.com/30hours/3lips /opt/3lips +sudo docker compose up -d —build +‘’’ + +The API front-end is available at [http://localhost:49156](http://localhost:49156). + +## Method of Operation + +The association uses the following algorithm: + +- ADS-B associator will associate the highest SNR target within some delay and Doppler boundary around the truth. + +The coordinate registration uses 1 of the following algorithms: + +- + +The system architecture is as follows: + +- The API server and HTML pages are served through a [Flask](http://github.com/pallets/flask) in Python. +- An initial API request with a new set of parameters (algorithms or radar nodes) will add these parameters to a common processing loop. This is so fair comparisons can be made between these parameters on the same input data. +- A set of API parameters will continue to be processed unless there is no API call in some specified time - see *main.py* to update. This allows the latest geolocation to be provided, rather than adding to the processing loop and waiting for the update from the next time increment. + +## Future Work + +- Implement an association algorithm that is not reliant on ADS-B truth. +- Add a variety of methods for solving the ellipse/ellipsoid intersection. +- Choose to use detection or track data from each radar. +- Long term plots to show metrics such as 2D location accuracy to ADS-B, number of aircraft tracked, etc. + +## License + +[MIT](http://choosealicense.com/licenses/mit) +