Getting started

Welcome to the Simplex python documentation. This section provides comprehensive information about the Simplex API and how to integrate it into your applications.

New to Python or Programming?

Before getting started, make sure you have all the necessary software installed. Check our Prerequisites Guide for a complete setup walkthrough.

To get started with the Simplex API, you'll need to:

1. Installation: Install the required SDK or libraries
2. Authentication: Set up your API credentials

Installation

To install the Simplex Python API, open a terminal and use the following command which will install the latest package from python package manager PyPi.:

pip install simplexpy

Check that Simplex API is installed correctly:

simplex --version

You should see something like simplex, version 0.1.0.

---

Authentication

To authenticate with the Simplex service:

simplex auth login

License Required

A valid Simplex license is required to use the API and perform calculations. Please ensure you have an active license before attempting to use the SDK features.

Support

For questions or support, please contact Simplex Support.

---

This API documentation is continuously updated. Please check back regularly for the latest information and new features.