Mac Installation Instructions

Mac installation instructions

Before installing simsopt, get openmpi either through HomeBrew or MacPorts. Then install conda

Macports

1. Install macports. The installation instructions can be found here.

2. Install gcc. Here gcc9 is selected. To select other versions use port search gcc.

   sudo port install gcc9

3. After installing gcc9, set it as default gcc. To find the installed versions of gcc use the command port select --list gcc. Since we have only gcc9,

   sudo port select --set gcc mp-gcc9

4. Install openmpi.

   sudo port install openmpi

Conda installation instructions

Coming soon.

Install simsopt

0. If using conda virtual environment, activate the virtual environment

   conda activate <your_ve>

1. Install simsopt. It is advisable to install mpi4py also along with simsopt.
   1. If installing from pypi, it is very simple.

      pip install "simsopt[MPI]"

   2. For local install, get the source code either by downloading the zip file and unzip or via git. Then change to the simsopt directory and do a local install. For editable install (if you are a developer, you don't want to reinstall simsopt after changing the source code), use the -e flag.

      cd simsopt
      pip install -e ".[MPI]"