|
1 | | -========= |
2 | | -Files |
3 | | -========= |
| 1 | +Files and Directory Structure |
| 2 | +============================= |
4 | 3 |
|
5 | | -This page gives a brief info of all the files provided in treesim_lpy repository |
| 4 | +This document provides an overview of the important files and directories in the `lpy_treesim` project. |
6 | 5 |
|
7 | | -* examples/* |
8 | | - * examples/static_envy.lpy - Grows a tree in the envy architecture following predefined rules. No thinning and/or tying takes place. |
9 | | - * examples/static_ufo.lpy - Grows a tree in the ufo architecture following predefined rules. No thinning and/or tying takes place. |
10 | | - * examples/UFO_tie_prune_label.lpy - This file allows the growth of a tree in ufo architecture following the given thinning and tying rules. Further has the option to label different segments as well |
11 | | - * examples/Envy_tie_prune_label.lpy - This file allows the growth of a tree in ufo architecture following the given thinning and tying rules. Further has the option to label different segments as well |
| 6 | +Top-Level Files |
| 7 | +--------------- |
12 | 8 |
|
13 | | -* modules_test/* |
14 | | - * All files in this folder use classes/functions defined in stochastic_tree.py. They can be a good example on how to use the BasicWood, Wire and Support classes |
| 9 | +- **`README.rst`**: The main README file for the project. |
| 10 | +- **`helper.py`**: Contains helper functions used by other scripts in the project. |
| 11 | +- **`stochastic_tree.py`**: The core module for generating stochastic trees. |
| 12 | +- **`.gitignore`**: A file that specifies which files and directories to ignore in a Git repository. |
15 | 13 |
|
16 | | -* other_files/* |
17 | | - * These files may or may not work. These were used in previous iterations of treesim_lpy. Kept to be used as a reference. |
| 14 | +`docs/` |
| 15 | +------- |
| 16 | + |
| 17 | +This directory contains the documentation for the project. |
| 18 | + |
| 19 | +- **`Makefile`**: A makefile with commands to build the documentation. |
| 20 | +- **`source/`**: The source files for the documentation, written in reStructuredText. |
| 21 | + - **`conf.py`**: The configuration file for Sphinx, the documentation generator. |
| 22 | + - **`index.rst`**: The main entry point for the documentation. |
| 23 | + - **`installation.rst`**: Instructions on how to install the project. |
| 24 | + - **`usage.rst`**: An explanation of how to use the project. |
| 25 | + - **`files.rst`**: An overview of the important files and directories in the project. |
| 26 | + - **`resources.rst`**: A list of resources related to the project. |
| 27 | + - **`methods.rst`**: A description of the methods used in the project. |
| 28 | +- **`_static/`**: Static files, such as images and videos, that are used in the documentation. |
| 29 | + |
| 30 | +`examples/` |
| 31 | +----------- |
| 32 | + |
| 33 | +This directory contains example `.lpy` files that demonstrate how to use `lpy_treesim`. |
| 34 | + |
| 35 | +- **`legacy/`**: Older example files. |
| 36 | +- **`UFO/`**: Examples related to the UFO cherry tree architecture. |
| 37 | + |
| 38 | +`modules_test/` |
| 39 | +--------------- |
| 40 | + |
| 41 | +This directory contains test files for the modules in the project. The files in this folder use classes and functions defined in `stochastic_tree.py` and can be a good example of how to use the `BasicWood`, `Wire`, and `Support` classes. |
| 42 | + |
| 43 | +`other_files/` |
| 44 | +-------------- |
| 45 | + |
| 46 | +These files may or may not work. They were used in previous iterations of `lpy_treesim` and are kept for reference. |
| 47 | + |
| 48 | +`tree_generation/` |
| 49 | +------------------ |
| 50 | + |
| 51 | +This directory contains scripts for generating and converting tree models. |
0 commit comments