Skip to content

Commit

Permalink
Split README.md in two parts: installation for pyjeo and full install…
Browse files Browse the repository at this point in the history
…ation
  • Loading branch information
Pieter Kempeneers committed Jan 26, 2021
1 parent 288e43e commit 0593011
Showing 1 changed file with 36 additions and 17 deletions.
53 changes: 36 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
Welcomne to miallib!

# Installation for pyjeo

This part explains how to install miallib as a dependency for pyjeo

## Build time dependencies

```
Expand All @@ -21,45 +25,60 @@ DEBIAN_FRONTEND='noninteractive' sudo apt install -yq \
python \
python-numpy \
uthash-dev \
texlive
libshp-dev
```

To build just the generic library for pyjeo:

```
make build
make generic
```

The documentation generation for pymia used epydoc for python2.7 and sphinx for 3.6.

+ Caveat: for the documentation, if texlive version is >= 2019, doxygen >= 1.8.16 needs to be installed!

To build just the generic library without Python and Lisp for pyjeo:
## Install

```
make generic
sudo make install-generic
```

### Local builds only!!!
# Full installation (not for pyjeo)

Our docker containers use a customized gdal build which links to `libshp`.
When we use that, we shouldn't link `miallib` to `libshp`.
This part explains how to install miallib (not only as a dependency for pyjeo)

For local builds though, we also need to link `miallib` with `libshp`. So:
## Build time dependencies

```
sudo apt install -y libshp-dev
sudo apt update
DEBIAN_FRONTEND='noninteractive' sudo apt install -yq \
git \
build-essential \
libgsl-dev \
libgsl0-dev \
libfann-dev \
libgeotiff-dev \
libfftw3-dev \
libproj-dev \
libjsoncpp-dev \
libgdal-dev \
libssl-dev \
doxygen \
swig \
python \
python-numpy \
uthash-dev \
libshp-dev \
texlive
```

## Install
To build:

```
sudo make install
make build
```

To install just the generic library without Python and Lisp for pyjeo:
## Install

```
sudo make install-generic
sudo make install
```

## Usage
Expand Down

0 comments on commit 0593011

Please sign in to comment.