Skip to content

Commit

Permalink
doc: update readme on dependency and installation
Browse files Browse the repository at this point in the history
  • Loading branch information
ACornuIGN committed Dec 10, 2024
1 parent c324a7c commit 8dce820
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 6 deletions.
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,32 @@ Why Borea? B for Box and orea is a back slang of aero.

## Dependency

Borea needs:
- python >= 3.9
- gdal >= 3.3.2
- numpy <= 1.26.4
- pyproj
- scipy
- pandas
- dataclasses

### Conda/Mamba
For conda/mamba environment the depencency is [borea_dependency/environment.yml](./borea_dependency/environment.yml).
For conda/mamba environment is [borea_dependency/environment.yml](./borea_dependency/environment.yml).

### Pip venv
For pip environment (venv) the depencency is [borea_dependency/requirements.txt](./borea_dependency/requirements.txt)
For pip environment (venv) is [borea_dependency/requirements.txt](./borea_dependency/requirements.txt)
and you need to install `libgdal-dev` and `GDAL>=3.3.2`.

## Installation

You need to retrieve the repository with ```git clone``` and install the environment. By ```conda``` or ```mamba``` with ```environment.yml``` or ```pip``` with ```requirements.txt```.
There are two ways to install Borea with the repository `git clone` or with pip `pip install ign-borea` [doc](./README_borea_lib.md).

With **the repository**, you also need to install the environment.
With **pip** the environment comes with it but does not contain GDAL, which you have to install yourself.

### Installation of the environment
#### Conda/Mamba
GDAL is contained and installed in the conda/mamba environment.
```
conda env create -f ./borea_dependency/environment.yaml
```
Expand All @@ -41,8 +55,7 @@ mamba env create -f ./borea_dependency/environment.yaml
```

#### Pip
The package exists on pip with `pip install ign-borea` without GDAL

GDAL is not included in the pip environment, so you have to install it yourself.
```
pip install -r ./borea_dependency/requirements.txt
sudo apt-get install libgdal-dev
Expand Down
7 changes: 6 additions & 1 deletion README_borea_lib.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,11 @@ pip install GDAL==<GDAL VERSION FROM OGRINFO>
```
You can find more information on [mothergeo-py](https://mothergeo-py.readthedocs.io/en/latest/development/how-to/gdal-ubuntu-pkg.html) if you have problems installing GDAL.

#### Conda/Mamba

You create your conda/mamba environment with pip in it, then in the environment you install borea with `pip install ign-borea` and GDAL with `conda install GDAL` or `mamba install GDAL`.
Note: GDAL version must be >= 3.3.2

#### In the QGIS environment

View the doc on [borea github docs/installation/In_QGIS.md](https://github.com/IGNF/Borea/tree/main/docs/installation/In_QGIS.md).
Expand Down Expand Up @@ -101,7 +106,7 @@ The DataFrame **pt3d** is a table with 5 column and n line. The id of column mus

it can be created with the function `read_file_pt_dataframe(path_file_pt,header_file,"pt3d")`
The dictionary **pinit** which give the initialization point X, Y, Z. A point on the worksite with a z at an approximate flying height. The name of the key in the dictionary is `coor_init`.
Example at the end of explanation of function [file](https://github.com/IGNF/Borea/tree/main/docs/functions/Space_resection.md).
Example at the end of explanation of function [file](https://github.com/IGNF/Borea/tree/main/examples/eg_space_resection.py) l.38.

* You can calculate some control point statistics to see how accurate your site is `stat = Stat(work, pathreturn, control_type)` to init the object and run for all stat with `stat.main_stat_and_save()`. Make stat on function image to world and world to image, if there are data. And save result on *pathreturn/Stat_{Name_worksite}.txt*.

Expand Down

0 comments on commit 8dce820

Please sign in to comment.