Skip to content

Getting Started

OpenSCvx is a JAX-based Python library for trajectory optimization using Successive Convexification (SCvx). It provides a simple interface for formulating and solving trajectory optimization problems with continuous-time constraint satisfaction.

Key Features

  • JAX-based: Automatic differentiation, vectorization, and compilation
  • Continuous-time constraints: Support for path constraints that must be satisfied at all times
  • Successive Convexification: Robust optimization algorithm for non-convex problems
  • Multiple constraint types: Continuous-time, nodal, and boundary constraints
  • Interactive visualization: 3D plotting and real-time optimization visualization
  • Code generation: Automatic C++ code generation for optimization problems
  • **Faster solver performance through compiled code for smaller problems
  • **Support for customized solver backends like QOCOGen

Installation

You can install OpenSCvx using pip. For the most common use case, which includes support for interactive plotting and code generation, you can install the library with the gui and cvxpygen extras:

pip install openscvx[gui,cvxpygen]

If you only need the core library without the optional features, you can run:

pip install openscvx

For the latest development version, you can clone the repository and install it in editable mode:

# Clone the repo
git clone https://github.com/haynec/OpenSCvx.git
cd OpenSCvx

# Install in editable mode with all optional dependencies
pip install -e ".[gui,cvxpygen]"

Dependencies

OpenSCvx has a few optional dependency groups:

The core dependencies are installed automatically with openscvx:

  • cvxpy - for convex optimization
  • jax - for fast linear algebra, automatic differentiation, and vectorization
  • numpy - for numerical operations
  • diffrax - for automatic differentiation
  • termcolor - for colored terminal output

  • plotly - for basic interactive 3D plotting

  • gui: For interactive 3D plotting and real-time visualization. This includes:

    • pyqtgraph - for realtime 3D plotting
    • PyQt5 - for GUI
    • scipy - for spatial operations
    • PyOpenGL - for 3D plotting
    • PyOpenGL_accelerate (optional, for speed) - for 3D plotting

  • cvxpygen: For C++ code generation, enabling faster solver performance on smaller problems. This includes:

    • cvxpygen - for C++ code generation
    • qocogen - fast SOCP solver

Local Development

For setting up a local development environment, we recommend using Conda to manage environments.

Via Conda 1. Clone the repository: 
git clone https://github.com/haynec/OpenSCvx.git
cd OpenSCvx
2. Create and activate the conda environment from the provided file: 
conda env create -f environment.yml
conda activate openscvx
3. Install the package in editable mode with all optional dependencies: 
pip install -e ".[gui,cvxpygen]"
Via pip and venv 1. Clone the repository: 
git clone https://github.com/haynec/OpenSCvx.git
cd OpenSCvx
2. Create and activate a virtual environment: 
python3 -m venv venv
source venv/bin/activate
3. Install the package in editable mode with all optional dependencies: 
pip install -e ".[gui,cvxpygen]"

Next Steps