Welcome to the pyGimli Tree repository. Scope of the project:

• Forward and inverse modeling of realistic tree data for both 2D and 3D, using prior information on tree geometry

• Introduction
• Installation
  • Conflicting packages
• Download sample data
• Project Development
  • Maintainers
• License, use and attributions

More info about project here

First, you will need a new Python 3 environment. The easiest way is to use Anaconda.

In the following we provide detailed installation instructions.

1. Create a new anaconda environment

conda create -n pg

2. Activate the environment and install pygimli.
3. Remember to activate the environment every time you want to work on the project.

conda activate pg

conda install -c gimli pygimli 

3. Clone the repository:

git clone https://github.com/shakasaki/pgTree.git

cd pgTree

5. Install the package locally by using the file setup.py by doing:

python -m pip install -e .

In the terminal type:

python core/download_data.py

Running this code a second time will not trigger a download since the file already exists.

Write about development

Feel free to download and use the Bedretto general model in your work! We do not provide any warranty and any guarantee for the use, but we aim to help and answer questions posted as Issues on the repository page as quickly as possible.

The model is published under an GNU Lesser General Public License v3.0, which means that you are free to use it. If you do any modifications, especially for scientific and educational use, then please provide them back to the main project in the form of a pull request.

If you have questions on the procedure, feel free to contact us about it.