Installation & Setup

This SDK is currently compatible with Python 3.6/3.7 and backwards-compatible with Python 2.7. However, future versions may lose Python 2.7 compatibility due to official end of support of the Python 2 language on January 1, 2020. There are a variety of ways to set up a Python 3 environment and install this library. For the sake of simplicity, a generalized “basic” installation guide and a guide for users of the Anaconda Distribution are provided. The recommended setup for all users (including those new to Python/coding) is that of the Anaconda distribution, as it is more prevalent in the scientific and engineering community.

Basic Installation

  1. Install the latest version of Python, if not already installed.
  2. (Optional, but recommended) Create a virtual environment. Open a terminal/command prompt, navigate to your new project’s directory, and follow the instructions for installing and activating a virtualenv.
  3. Install plantpredict via pip by typing the command pip install plantpredict into the terminal.
  4. Follow the steps in API Authentication to obtain API credentials and authenticate with the server.
  5. Use the tutorials in Example Usage as a starting point for your own scripting and analysis. Detailed documentation on each class and method can be found in SDK Reference.