1. Getting Started

Some IBCDFO functionality requires the use of the MINQ code. Therefore, both Python and MATLAB users should install a local MINQ clone prior to testing or using IBCDFO. Each version of IBCDFO is linked to a single commit in the MINQ repository, which was typically the latest commit on the MINQ main branch at the time that the IBCDFO version was released. If a user’s MINQ clone is not set to the correct commit, an error message indicates the commit required by the user’s IBCDFO installation.

Similarly, testing IBCDFO requires that Python and MATLAB users install a BenDFO local clone. Prior to running tests, users should ensure that their BenDFO clone is set to the latest commit on main.

1.1. Python Installation

After installing a MINQ clone and before testing or using a Python IBCDFO installation, provide to Python the location of your MINQ installation by adding

/path/to/MINQ/py/minq5

to your PYTHONPATH environment variable.

1.1.1. Install from PyPI

The IBCDFO Python package is available for installation via PyPI. It can be installed by setting up a terminal with the desired target Python and executing

python -m pip install ibcdfo

1.1.2. Install from Clone

A static installation of the IBCDFO Python package can be made using the contents of a local IBCDFO clone by setting up a terminal with the desired target Python and executing

$ cd /path/to/IBCDFO/ibcdfo_pypkg
$ python -m pip install .

1.1.3. Testing the Installation

Before testing the IBCDFO package, specify BenDFO’s location by adding

/path/to/BenDFO/py

to your PYTHONPATH environment variable. To test an installation, from the /path/to/BenDFO/data directory execute

$ python
>>> import ibcdfo
>>> ibcdfo.__version__
<version>
>>> ibcdfo.test()

where the output <version> should be identical to the value used during installation.

1.2. MATLAB Installation

A MATLAB installation of IBCDFO requires installing a local clone of the IBCDFO repository and adding

/path/to/MINQ/m/minq5
/path/to/MINQ/m/minq8

to the MATLAB path. To simplify testing, MATLAB users should prefer installing BenDFO in the same folder as their IBCDFO clone.

To run tests,

open MATLAB in the tools folder,

execute test_ibcdfo, and

inspect output.