Skip to content

VirtualPlantLab/VirtualPlantLab.jl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

VirtualPlantLab

Stable CI SciML Code Style ColPrac: Contributor's Guide on Collaborative Practices for Community Packages Aqua QA DOI

This is the main package in the Virtual Plant Lab that users are meant to download and use. It is a meta-package that includes all the other packages in the VirtualPlantLab organization where the different features are implemented. The user does not need to be aware of the other packages, except in cases where methods need to be define for user-defined types (currently that is the case for PlantGeomTurtle.feed!() which is required to generate geometry from user-defined types).

1. Installation

You can install the latest stable version of VirtualPlantLab.jl with the Julia package manager:

] add VirtualPlantLab

Or the development version directly from here:

import Pkg
Pkg.add(url="https://github.com/VirtualPlantLab/VirtualPlantLab.jl", rev = "master")

or

] add VirtualPlantLab#master

2. Usage

To start using VirtualPlantLab.jl, you need to load it first:

using VirtualPlantLab

The entire API of the Virtual Plant Lab will become available after loading.

For people starting, it is recommended to follow the tutorials in the documentation. The entire API is also documented there.

3. Additional packages

The following packages are also of interest when building models with the Virtual Plant Lab: