# UnLynx

[![Build Status](https://travis-ci.org/ldsec/unlynx.svg?branch=master)](https://travis-ci.org/ldsec/unlynx) [![Go Report Card](https://goreportcard.com/badge/github.com/ldsec/unlynx)](https://goreportcard.com/report/github.com/ldsec/unlynx) [![Coverage Status](https://coveralls.io/repos/github/ldsec/unlynx/badge.svg?branch=master)](https://coveralls.io/github/ldsec/unlynx?branch=master)

UnLynx is a library for simulating a privacy-preserving data sharing tool. It offers a series of independent protocols that when combined offer a verifiably-secure and safe way to share sensitive data (e.g., medical data).

UnLynx is developed by LDS (Laboratory for Data Security in EPFL) in collaboration with DeDis (Laboratory for Decentralized and Distributed Systems).

### Documentation

* The UnLynx library does an intensive use of [Overlay-network (ONet) library](https://github.com/dedis/onet) and of the [Advanced Crypto (kyber) library](https://github.com/dedis/kyber).
* For more information regarding the underlying architecture please refer to the stable version of ONet `go.dedis.ch/onet/v3`
* To check the code organisation, have a look at [Layout](https://github.com/ldsec/unlynx/wiki/Layout)
* For more information on how to run our protocols, services, simulations and apps, go to [Running UnLynx](https://github.com/ldsec/unlynx/wiki/Running-UnLynx)

### Version

We have a development and a stable version. The `master`-branch in `github.com/ldsec/unlynx` is the development version that works but can have incompatible changes.

Use the latest tag `v1.4.1` that are stable and has no incompatible changes.

### License

UnLynx is licensed under an End User Software License Agreement ('EULA') for non-commercial use. If you need more information, please contact us.

### Contact

You can contact any of the developers for more information or any other member of [github.com/ldsec/](https://search.epfl.ch/?filter=unit\&q=github.com/ldsec/):

* [David Froelicher](https://github.com/froelich) (PHD student) - <david.froelicher@epfl.ch>
* [Patricia Egger](https://github.com/pegger) (Security Consultant at Deloitte) - <paegger@deloitte.ch>
* [Joao Andre Sa](https://github.com/JoaoAndreSa) (Software Engineer) - <joao.gomesdesaesousa@epfl.ch>
* [Christian Mouchet](https://github.com/ChristianMct) (PHD student) - <christian.mouchet@epfl.ch>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://ldsec.gitbook.io/unlynx/master.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.