Commit 193911be authored by Jean-Loup Haberbusch's avatar Jean-Loup Haberbusch
Browse files

UPDATED Wiki pages formatted for MKDocs

parent 2cbf6e7d
Pipeline #10983 passed with stages
in 21 seconds
# Setup CamiTK 4 Development Environment
Contents:
<!-- @import "[TOC]" {cmd="toc" depthFrom=2 depthTo=6 orderedList=false} -->
<!-- code_chunk_output -->
* [Setup the stable development environment](#setup-the-stable-development-environment)
* [Setup the CamiTK bleeding edge development environment](#setup-the-camitk-bleeding-edge-development-environment)
<!-- /code_chunk_output -->
This is required to **develop a new CamiTK Extension Project**.
Installing the developer environment depends on the OS on which you are planning to develop.
......@@ -17,7 +8,7 @@ We recommend that you use the last stable version of CamiTK (see below for the _
## Setup the stable development environment
Currently the CamiTK team supports the following OS:
- [Setup CamiTK Development Environment on Debian Stable (stretch)](./debian-stable)
- [Setup CamiTK Development Environment on Debian Stable (stretch)](./debian-stable)
- [Setup CamiTK Development Environment on Ubuntu LTS (16.04 or 18.04)](./ubuntu-lts)
- [Setup CamiTK Development Environment on Debian Old Stable (jessie)](./debian-old)
- [Setup CamiTK Development Environment on Windows 7](./win-7)
......@@ -36,4 +27,4 @@ We advise you to use the `develop` branch if and only if:
If you just want to get on working, just use the stable version.
For the `develop` version we recommend to use debian stable, Ubuntu 17.04 or 17.10:
- [Setup bleeding edge CamiTK Development Environment on Debian Stable, Ubuntu 17.04 or 17.10](./install-camitk-develop)
\ No newline at end of file
- [Setup bleeding edge CamiTK Development Environment on Debian Stable, Ubuntu 17.04 or 17.10](./install-camitk-develop)
# Setup CamiTK bleeding edge Development Environment on Debian Stable, Ubuntu 17.04 or 17.10
Contents:
<!-- @import "[TOC]" {cmd="toc" depthFrom=2 depthTo=6 orderedList=false} -->
<!-- code_chunk_output -->
* [Install CamiTK development version from the `develop` branch](#install-camitk-development-version-from-the-develop-branch)
* [Dependencies](#dependencies)
* [Clone and build CamiTK from the `develop` branch](#clone-and-build-camitk-from-the-develop-branch)
* [Development tools](#development-tools)
* [Check the installation](#check-the-installation)
<!-- /code_chunk_output -->
Start from a fresh `debian-stable`, `Ubuntu 17.04` or `Ubuntu 17.10` install, you will need to:
- install the the dependencies and CamiTK from the `develop` branch source code
- Install the recommended development tools
......@@ -27,12 +14,13 @@ To install CamiTK dependencies, just type:
sudo apt-get build-dep camitk
```
Note: if you get the following error message
!!! Note
if you get the following error message
```bash
E: You must put some 'source' URIs in your sources.list
```
you need to add source repository, see the [debian documentation](https://wiki.debian.org/SourcesList)
```bash
E: You must put some 'source' URIs in your sources.list
```
you need to add source repository, see the [debian documentation](https://wiki.debian.org/SourcesList)
### Clone and build CamiTK from the `develop` branch
......@@ -41,7 +29,7 @@ you need to add source repository, see the [debian documentation](https://wiki.d
git clone -b develop --single-branch https://gricad-gitlab.univ-grenoble-alpes.fr/CamiTK/CamiTK.git
mkdir build-CamiTK
cd build-CamiTK
cmake ../CamiTK -DCEP_IMAGING=TRUE -DCEP_MODELING=TRUE -DCEP_TUTORIALS=TRUE -DCMAKE_INSTALL_PREFIX="/usr/local"
cmake ../CamiTK -DCEP_IMAGING=TRUE -DCEP_MODELING=TRUE -DCEP_TUTORIALS=TRUE -DCMAKE_INSTALL_PREFIX="/usr/local"
make
sudo make sdk_global_install
```
......
# Setup CamiTK 4 Development Environment on Ubuntu LTS (Xenial 16.04)
Contents:
<!-- @import "[TOC]" {cmd="toc" depthFrom=2 depthTo=6 orderedList=false} -->
<!-- code_chunk_output -->
* [Install dependencies and build tools](#install-dependencies-and-build-tools)
* [Build and install CamiTK 4 stable](#build-and-install-camitk-4-stable)
* [Install development tools](#install-development-tools)
* [Check the installation](#check-the-installation)
<!-- /code_chunk_output -->
In order to develop on Ubuntu LTS (16.04 or 18.04), you will need to:
- install required dependencies and build tools
- build and install CamiTK 4 stable
- install development tools to work on your CEP.
Note that this should work for any Ubuntu version older than 16.04.
!!! Note
that this should work for any Ubuntu version older than 16.04.
## Install dependencies and build tools
This is quite easy as everything is available as packages.
Just type:
```bash
```bash
export CAMITK_LATEST="4.1.2"
workingDir=$(mktemp --tmpdir -d camitk-$CAMITK_LATEST-build-tmp.XXX)
cd $workingDir
......@@ -34,14 +24,14 @@ sudo mk-build-deps -t "apt -y --no-install-recommends -o Debug::pkgProblemResolv
## Build and install CamiTK 4 stable
```bash
```bash
cd $workingDir
wget https://gricad-gitlab.univ-grenoble-alpes.fr/CamiTK/CamiTK/-/archive/$CAMITK_LATEST/CamiTK-$CAMITK_LATEST.tar.gz
tar xf CamiTK-$CAMITK_LATEST.tar.gz
mkdir build
cd build
cmake ../CamiTK-$CAMITK_LATEST -DCEP_IMAGING=TRUE -DCEP_MODELING=TRUE -DCEP_TUTORIALS=TRUE -DCMAKE_INSTALL_PREFIX="/usr/local"
make # To build in parallel: add -jX where X is your number of CPU
cmake ../CamiTK-$CAMITK_LATEST -DCEP_IMAGING=TRUE -DCEP_MODELING=TRUE -DCEP_TUTORIALS=TRUE -DCMAKE_INSTALL_PREFIX="/usr/local"
make # To build in parallel: add -jX where X is your number of CPU
sudo make camitk-ce-global-install
```
......
# Setup CamiTK 4 Development Environment on Windows 7
Contents:
<!-- @import "[TOC]" {cmd="toc" depthFrom=2 depthTo=6 orderedList=false} -->
<!-- code_chunk_output -->
* [Development tools](#development-tools)
* [CamiTK development environment](#camitk-development-environment)
* [Set environment variables](#set-environment-variables)
* [Configuring, generating and compiling CamiTK 4](#configuring-generating-and-compiling-camitk-4)
* [configure and generate files to build](#configure-and-generate-files-to-build)
* [Compile](#compile)
* [Try to run CamiTK from your build](#try-to-run-camitk-from-your-build)
* [Check the installation](#check-the-installation)
<!-- /code_chunk_output -->
Start from a fresh `Windows 7` install
......@@ -74,11 +59,12 @@ Run `Rapid Environment Editor` with the administrator rights and edit the system
C:\dev\VTK\6.3\bin;
```
**Note:**
- The Qt path depends on where you installed Qt
- The prefix `C:\dev\..` also depends on where you installed the CamiTK developer package
!!! Note
- The Qt path depends on where you installed Qt
- The prefix `C:\dev\..` also depends on where you installed the CamiTK developer package
> We only support CamiTK installation on Windows for 64 bits using Visual Studio 2015. Visual Studio 2017 is known to work. If you decide to install another version of Visual Studio, do it at your own risk! You may ask for help on the forum but unfortunately we do not have a lot of free time to help developer with non officially supported configuration.
!!! Warning
We only support CamiTK installation on Windows for 64 bits using Visual Studio 2015. Visual Studio 2017 is known to work. If you decide to install another version of Visual Studio, do it at your own risk! You may ask for help on the forum but unfortunately we do not have a lot of free time to help developer with non officially supported configuration.
## Configuring, generating and compiling CamiTK 4
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment