You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The technical notes are useful for people who want to understand the internal details of VPL
75
-
and how different algorithms are implemented (i.e. the technical notes should be seen as a
76
-
supplement to the source code of VPL).
58
+
In this website, documentation for VPL is provided in different formats, with different purposes or functions:
59
+
60
+
| Documentation type | User type | Function |
61
+
|:---|:---|:---|
62
+
| Tutorials | New users | The tutorials were developed to gradually introduce new users to relevant functionalities and packages of VPL to construct, simulate, and visualize FSP models. The end product is not really important, or sometimes related to FSP models, but the users learn important practical knowledge that may be useful to build your first FSP model in VPL. |
63
+
| Manual | All users | This manual describes the different concepts used in VPL and gives an overview of the options available. These include Julia concepts used in VPL, creating and manipulating dynamic graphs, ray tracing, visualization, and simulation of scenes. This manual is meant to be used the new users who are going through tutorials, as well as any other user. |
64
+
| API | All users | The API documentation describes each function and data type of the VPL core, with an emphasis on the inputs and outputs of the basic packages that provide the functionality to build FSP models. In addition to this website, it can be accessed from within Julia with `?` (see [Documentation](https://docs.julialang.org/en/v1/manual/documentation/) in the Julia manual). |
65
+
| VPLverse | All users | The API and package documentation for each component of VPLverse, the ecosystem of packages built around VPL that provide additional support to plant modelers to implement ecophysiology and biophysical processes, simulate and model plants, soil, and atmosphere, as well as simulate different sky conditions and light distribution. In addition to this website, it can be accessed from within Julia with `?`. |
66
+
| How-to guides | All users | These guides target specific issues or objectives in the context of working with FSP models on VPL. In contrast to tutorials, how-to guides focus on individual problems and their intricacies. The objective is to acquaint users with specific functionalities, eliminating the need for users to repeatedly go back to tutorials to find problem-solving information. |
67
+
| Developers | Advanced users | This documentation is useful for people who want to understand the internal details of VPL and how algorithms are implemented. Additionally, it guides users on the development of packages and styling protocol adopted for VPL and VPLverse. |
0 commit comments