yao::install from source
HOME | INSTALL | MANUAL | NEWS
This page contains somewhat detailled instructions to install yorick, the yorick plugins and FFTW3 from source.

## Yorick

Download the latest Yorick distribution from the yorick site. Installation is straighforward (see the README file in the main distribution directory). I suggest you install yorick in `~/yorick-version_number` (just put, e.g. `yorick-2.1.05.tgz` in your home directory, gunzip and untar). If you already have yorick installed you may of course skip this last point.

Configure, build and install yorick. Out of the many ways to do this, I suggest:

    cd ~/yorick-2.1   (or wherever you put it)
    make Y_HOME=`pwd` ysite
    make config
    make
    make install

I recommend to build yorick and the plugins with "CFLAGS=-O2".

yorick should be in `~/yorick-2.1/bin/`. Remember to add this to your PATH, e.g., if you use bash (put this at the end of you .bashrc -Linux- or .profile -OsX-):

    export PATH=${HOME}/yorick-2.1/bin:${PATH}

An very convenient addon, that will save you tons of time, is rlwrap. If you runs yorick within rlwrap, it will provide command line editing and recall, command and filenames completion, etc... I have defined an alias (bash) for yorick as follow:

    alias yorick='rlwrap -s 2000 -c -f ~/.yorick/yorick.commands yorick'

## Yorick Plugins

Installing yorick plugins follow fairly generic rules:

1. Download the plugin (raw list, webpage). Make sure you get the last version. For yao, as said elsewhere, you will need yutils, imutil and, optionally, soy. And of course yao itself.
2. You can expand the plugin and build it from anywhere. However, to keep traces and keep the original, I recommend to put it in `Y_HOME/contrib` (`Y_HOME` is where your yorick is, i.e. ~/yorick-2.1). Create the `contrib` directory if it doesn't exist.
3. gunzip and untar the file downloaded in (1), cd in the plugin directory

       tar zxvf plugin-version-src.tgz
       cd plugin-version

4. Update the makefile to work with your yorick:

       yorick -batch make.i

5. if the plugin has dependencies, and the dependency libraries/headers are not in a standard place, you may need to edit the Makefile and change CFLAGS and LDFLAGS to accommodate these paths.
6. Build and install the plugin:

       make
       make install

   sudo the last comment if yorick is install system-wide.
7. You're done. Most plugins usually have some check.i or test.i of some form. Check in the directory and run it to check everything is working:

       yorick -i check.i

Technical details: a yorick plugin generally consist of some C files and yorick include files to go with it. Building the plugin means compiling the C files for your machine/OS/architexture/libraries. A plugin will install files within and only within your yorick directory tree: in `i`, `i0` and `lib`, and in some cases also in `python`, `share`, etc (still under `Y_HOME`).

## FFTW3

Not much to say here. These days, the FFTW install is generally flawless.

1. Download it from here
2. gunzip, untar, cd into fftw directory
3. Run the canonical (note the enable-float flag)

       ./configure --enable-float
       make
       make install

You may also specify a `prefix=/some/path` in configure if you don't have root access on your machine.

## Yao

Yao is a plugin, thus I refer you to the plugin instructions above.