Skip to content
Snippets Groups Projects

[Setup] Add support for development install

Merged Christophe Guillon requested to merge cguillon/aidge_core:dev/cguillon/setup-editable into dev
2 files
+ 86
18
Compare changes
  • Side-by-side
  • Inline
Files
2
  • 733b9b23
    Add support for pip -e development (editable) mode.
    Add some environment vars for configuring the cmake build in
    development mode:
    - AIDGE_BUILD_GEN=<cmake_backend>: for instance Ninja to use
      the ninja backend which better supports incremental build
    - AIDGE_BUILD_MODE=[Debug|Release]: define the build mode,
      defaults to Debug
    
    Note that due to behavior changes depending on the
    python/setuptools versions, the portable method to ensure
    incremental build on C++ files is to use:
    
    pip install --no-build-isolation -v -e .
    
    Refer to the doc string of setup.py for details.
+ 19
0
@@ -19,6 +19,25 @@ pip install . -v
export AIDGE_INSTALL='<path_to_aidge>/install'
```
## Development Mode installation
Install in development mode (local changes to python files and .cpp files do not require full installation)
with:
```bash
pip install cmake ninja # enforce build dependencies (added also ninja here as we request it as build backend)
export AIDGE_BUILD_GEN=Ninja
pip install --no-build-isolation -v -e .
```
After changes in a python file, no action is required, for changes in .cpp/.h file, re-execute:
```bash
pip install --no-build-isolation -v -e .
```
In this mode, the C++ compilation build system is located in the local `build/` directory.
Refer to the doc string in `setup.py`for more details on editable mode.
## Standard C++ Compilation
Create two directories ``build`` and ``ìnstall``.
Loading