Installing the software

Fracridge is available in two popular programming languages: MATLAB (tm) and Python.

MATLAB

Download the recent release of the software here, extract the files and place them in a folder of your choosing. Then, direct MATLAB to include the matlab folder in the top-level folder of the extracted archive in its path.

Python

To install the released version of the software, you can use the Python pip package manager. In a shell command line issue:

pip install fracridge

This should download and install the software for your use.

To upgrade the software to newer versions issue:

pip install -U fracridge

Alternatively, if you would like to download the source code, or install the bleeding edge of recent developments, To install from source, issue:

git clone https://github.com/nrdg/fracridge
cd fracridge
pip install -e .

If you use the latter installation method, you can update to the most recent version of the development of the code by pulling from GitHub. Installing with -e means that a symlink will be created from a location in your PYTHONPATH directly to the source code and changes to the code should propagate to your import of the code from your PYTHONPATH.

To see how to use the installed software, please read the user guide and read the examples