Subsections

4. Other installation-related information

4.1 Testing PLearn

Once PLearn compiles successfully, it is recommended to run the test-suite in order to ensure that the main components of the library work as expected. Go to $PLEARNDIR and launch pytest run --all. Note that, typically, the test-suite first compiles $PLEARNDIR/commands/plearn_tests, and thus may look like it is stalled, while it is actually compiling or linking in the background.

4.2 Generating the documentation locally

The doc subdirectory maintains the sources of the documentation that is also available on the PLearn website. To generate it locally from source you'll need the following software tools: