Skip to content

Latest commit

 

History

History
73 lines (60 loc) · 1.72 KB

README.md

File metadata and controls

73 lines (60 loc) · 1.72 KB
Raw

OptimPack plug-in for Yorick

This is Yorick plug-in for OptimPack.

Installation

In short, building and installing the plug-in can be as quick as:

cd $BUILD_DIR
$SRC_DIR/configure
make
make install

where $BUILD_DIR is the build directory (at your convenience) and $SRC_DIR is the source directory of the plug-in code. The build and source directories can be the same in which case, call ./configure to configure for building.

If the plug-in has been properly installed, it is sufficient to use any function of OptimPack to automatically load the plug-in. You may force the loading of the plug-in by something like:

#include "opky.i"

or

require, "opky.i";

in your code.

More detailled installation explanations are given below.

  1. You must have Yorick installed on your machine.

  2. Unpack the plug-in code somewhere.

  3. Configure for compilation. There are two possibilities:

    For an in-place build, go to the source directory, say $SRC_DIR, of the plug-in code and run the configuration script:

    cd $SRC_DIR
./configure

    To see the configuration options, call:

    ./configure --help

    To compile in a different build directory, say $BUILD_DIR, create the build directory, go to the build directory and run the configuration script:

    mkdir -p $BUILD_DIR
cd $BUILD_DIR
$SRC_DIR/configure

    where $SRC_DIR is the path to the source directory of the plug-in code. To see the configuration options, call:

    $SRC_DIR/configure --help

  4. Compile the code:

    make

  5. Install the plug-in in Yorick directories:

    make install