README.md

# Aidge

[![License-badge](https://img.shields.io/badge/License-EPL%202.0-blue.svg)](LICENSE)

description du framework

peut etre mettre mention a deepgreen

## Installation

### Build on Linux using pip

Each Aidge module are built independantly from one another.
To install Aidge on Linux using pip, follow those steps :
1. Create your python environnement with python >= 3.7. For example using virtualenv :
``` bash
virtualenv -p python3.8 py_env_aidge
source py_env_aidge/bin/activate
```

2. Set the desired install path :
``` bash 
export AIDGE_INSTALL = '<path_to_aidge>/install'
```

3. First build aidge_core :
``` bash
cd aidge/aidge_core/
pip install . -v
```

4. Then build other modules (for example aidge_cpu, aidge_onnx) :
``` bash 
cd aidge/aidge_cpu
pip install . -v 
```

## Docker Image

Feel free to use one of the Dockerfiles available in the [`docker`](docker) folder.

To build the image, run where your DockerFile is
```
docker build --pull --rm -f "name_of_os.Dockerfile" -t aidge:myenv .
```

Then to run a container, run
```
docker run --name mycontainer aidge:myenv
```

## Contributing

If you would like to contribute to the Aidge project, we’re happy to have your help!
Everyone is welcome to contribute code via merge requests, to file issues on Gitlab,
to help people asking for help, fix bugs that people have filed,
to add to our documentation, or to help out in any other way.
We grant commit access (which includes full rights to the issue database, such as being able to edit labels)
to people who have gained our trust and demonstrated a commitment to Aidge.

## License

Aidge has a Eclipse Public License 2.0, as found in the [LICENSE](LICENSE).