This project requires Python 3; it has been tested on Python 3.10 for Linux. It may be installed locally using the following command in the root directory of the project:
pip install .
Note that this project requires Plantri to be installed in the working directory (i.e., where the run script is located). For convenience, a copy of Plantri is compiled in the "examples" folder to run the examples.
To install Plantri, follow these steps:
- Download the source code from the link above and extract the archive.
Plantri can be downloaded from here. The source code is available as a .tar.gz archive. Download the archive and extract it to a directory of your choice.
-
Compile the source code.
cd plantri53 make plantriThis will compile the Plantri source code and create an executable called
plantriin the same directory. -
Verify that the Plantri command is now available by running the following command:
plantri -hThis should display the Plantri help message.
Usage instructions for this project are documented in the Python script within the ./examples folder.
The API reference for this project is documented in the "docs" directory. See ./docs/_build/html/index.html for the main page.