Quick Installation

Pockit itself is a pure Python library, but it depends on the binary library IPOPT for solving nonlinear programming problems. The basic installation steps are:

1. Install dependencies
2. Download the code from the GitHub repository and copy the pockit folder to the working directory

X86

The simplest way to install pockit and its dependencies is to use conda:

1. Install Anaconda, Miniconda, or Miniforge
2. Create a new environment and activate it (with Python version 3.11 or 3.12)

   conda create -n pockit python=3.12
   conda activate pockit
   

3. Install dependencies

   conda install -c conda-forge --file requirements.txt
   

4. Copy the pockit code folder to the working directory
5. (Optional) Install other potentially useful libraries

   conda install -c conda-forge matplotlib jupyter
   

ARM (Apple Silicon)

The conda-forge repository currently does not have IPOPT binaries for the ARM architecture. For macOS, you can install IPOPT via homebrew:

1. Install IPOPT

   brew install ipopt
   

2. Create a new environment and activate it

   conda create -n pockit python=3.12
   conda activate pockit
   

3. Install dependencies (at this point, you should use pip instead of conda, to utilize the IPOPT installed on the system)

   pip install -r requirements.txt
   

4. Copy the pockit code folder to the working directory
5. (Optional) Install other potentially useful libraries

   pip install matplotlib jupyter