Installing pyXSIM

Dependencies

pyXSIM 4.x is compatible with Python 3.9+, and requires the following Python packages:

pyXSIM also has the following optional dependencies:

  • mpi4py (for running in parallel)

Installing

pyXSIM can be installed in a few different ways. The simplest way is via the conda package if you have the Anaconda Python Distribution:

[~]$ conda install -c conda-forge pyxsim

This will install all of the necessary dependencies.

The second way to install pyXSIM is via pip. pip will attempt to download the dependencies and install them, if they are not already installed in your Python distribution:

[~]$ pip install pyxsim

Alternatively, to install into your Python distribution from source:

[~]$ git clone http://github.com/jzuhone/pyxsim
[~]$ cd pyxsim
[~]$ pip install .