Skip to content

Commit 6e50388

Browse files
authored
Update README.rst
1 parent 8b9d01b commit 6e50388

File tree

1 file changed

+85
-13
lines changed

1 file changed

+85
-13
lines changed

README.rst

Lines changed: 85 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,96 @@
22
TreeSim_Lpy
33
============
44

5+
Description
6+
-----------
7+
8+
TreeSim_Lpy is a tree modelling tool which is built upon L-py with the added features of pruning and tying trees down to mimic different architectures. The tool uses python and prior knowledge of L-systems and L-Py is needed to work with this tool. This tool is ideal for researchers and developers working on botanical simulations and robotic harvesting applications.
59

6-
TreeSim_Lpy is a tree modelling tool which is built upon L-py with the added features of pruning
7-
and tying trees down to mimic different architectures. The tool uses python and prior knowledge of L-systems
8-
and L-Py is needed to work with this tool.
910

1011
Python version 3.9
1112

13+
Table of Contents
14+
-----------------
15+
16+
- `Installation <#installation>`__
17+
- `Usage <#usage>`__
18+
- `Features <#features>`__
19+
- `Gallery <#gallery>`__
20+
- `Contact <#contact>`__
21+
- `Support <#support>`__
22+
- `Citations <#citations>`__
23+
24+
Documentation
25+
-------------
26+
27+
The documentation is provided at `Read the Docs <https://treesim-lpy.readthedocs.io/en/latest/>`__.
28+
29+
You can find the latest L-Py documentation at <https://lpy.readthedocs.io/en/latest>
30+
31+
32+
Installation
33+
------------
34+
35+
To install TreeSim_Lpy, follow these steps (adapted from the `L-Py documentation <https://treesim-lpy.readthedocs.io/en/latest/installation.html>`__):
36+
37+
1. **Install Conda**:
38+
39+
The L-Py distribution relies on the conda software environment management system. If you do not already have conda installed, you can find installation instructions on the `Conda Installation Page <https://docs.conda.io/projects/conda/en/latest/user-guide/install/>`__.
40+
41+
2. **Create a Conda Environment**:
42+
43+
Create an environment named `lpy`:
44+
45+
.. code-block:: sh
46+
47+
conda create -n lpy openalea.lpy -c fredboudon -c conda-forge
48+
49+
The package is retrieved from the `fredboudon` channel (development), and its dependencies will be taken from the `conda-forge` channel.
50+
51+
3. **Activate the L-Py Environment**:
52+
53+
.. code-block:: sh
1254
13-
The documentation is provided at https://treesim-lpy.readthedocs.io/en/latest/
14-
You can find the L-Py documentation at
15-
<https://lpy.readthedocs.io/en/latest>
55+
conda activate lpy
56+
57+
4. **Install Required Packages**:
58+
59+
.. code-block:: sh
60+
61+
pip install -r requirements.txt
62+
63+
5. **Run L-Py**:
64+
65+
.. code-block:: sh
66+
67+
lpy
68+
69+
Usage
70+
-----
71+
72+
Here is a basic usage example to get you started:
73+
74+
- **Loading a Tree Model:**
75+
76+
.. code-block:: python
77+
78+
Do some lpy things
79+
More lpy code
80+
produce something?
81+
82+
83+
84+
Features
85+
--------
86+
87+
- **Pruning:** Remove unwanted branches to simulate pruning.
88+
- **Branch Tying:** Simulate branches being tied down to mimic different orchard architectures.
89+
- **Model Class Types:** The model generated is built with classes of different material type.
1690

1791
========
1892
Gallery
1993
========
20-
.. figure:: media/envy.png
94+
.. figure:: media/envy_model.png
2195
:width: 500
2296
:height: 300
2397

@@ -30,17 +104,15 @@ Gallery
30104
:height: 300
31105

32106
Example of a labelled, pruned and tied UFO tree system using TreeSim_Lpy
33-
34107

35108

109+
Contact
110+
-------
36111

37-
=============
38-
Documentation
39-
=============
112+
For any questions or issues, please contact us through **GitHub Issues**.
40113

41-
Documentation is available at `<https://treesim-lpy.readthedocs.io/en/latest/>`_
42114

43-
Help and Support
115+
Support
44116
----------------
45117

46118
Please open an **Issue** if you need support or you run into any error (Installation, Runtime, etc.).

0 commit comments

Comments
 (0)