Yorick Plugins and Packages
A package is a set of interpreted yorick include files. A plugin includes compiled C (or C++, or fortran) objects, to extend the capabillities of yorick (e.g. wrap libraries).
As of yorick-1.6, Yorick has the capabilities to load packages that include dynamic libraries (plugins). This has several big advantages:
- it solves a distribution problem. One can now distribute packages in binary form, and they can be loaded by the current yorick executable,
- although it is still possible, it is not anymore necessary to build a special version of yorick when linking to custom C libraries,
- an arbitrary number and combination of packages can be loaded in a given yorick session.
Linux and MacOsX:
- You can use pkg_mngr to install plugins and packages (
#include "pkg_mngr.i"). This makes for painless install, the main advantage being that it includes external libraries (statically linked). - You can also install plugins from our debian/fedora/mandriva repositories (recommended).
Packages
Below you will find informations about contributed packages. More packages can be found by browsing the contrib and package/src directories.
These packages are written in yorick, i.e. contrarily to plugins, there is nothing to compile and they are ready to use 'as is'. The information below gives a short synopsis about the package and list the package dependencies, if any.
yutils
- This package, written primarily by Eric Thiebault, with some additions by F.Rigaut, Thibaut Paumard and B.Aracil, is a collection of routines of general utilities for Yorick. They include routines about plotting, polynomial, fft, histogram, linear algebra, fitting, ramdon number generators, reading data from files, string operations, and many more.
- Grab it here or install with pkg_mngr. Full help pages (note: outdated) for yutil here.
- There is no dependencies other than the regular yorick distribution.
Spydr
- A gtk based GUI to display and analyze fits images (or fits datacube).
- Grab it here or install with pkg_mngr.
Plugins
Unless stated otherwise, the following plugins are for use with yorick version 1.6.02 or greater. All of the packages below are for installation from source. For binary installation on linux and macosx, or use pkg_mngr.
yeti (+ yeti_regex, yeti_tiff, yeti_fftw, yeti_gsl)
Eric Thiébaut's yeti plugins.
- Summary: many many functions (system, hash tables, ...), plus TIFF I/O, POSIX regex wrapping and wrappers to fftw2 and gsl math functions
- Dependencies: tiff, jpeg, fftw2 and gsl libraries
- Known to compile on OsX, Linux and cygwin.
- Grab it here or install the binaries with pkg_mngr
- Author: E.Thiébaut.
yorick-z
David's plugin that includes IO to jpeg and png files, access to the compression library zlib and output to mpeg1.
- Summary: I/O to several image formats, output to mpeg1, compression
- Dependencies: jpeg, tiff, png, ffmpeg libraries
- Known to compile on OsX and Linux
- Grab it here or install the binaries with pkg_mngr
- read the README file for installation
- Author: D.Munro
yorick-gl
openGL yorick plugin
- Smart wrappers to openGL functions
- Dependencies: openGL
- Known to compile on OsX and Linux
- Grab it here
- read the README file for installation
- Author: Steven Langer
imutil
- Summary: Compiled routines for basic but fast image manipulation. Includes 2d bilinear and spline2 interpolation, clipping, 2d dist generator, binning, image rotation, cartesian to polar coordinate transform, gaussian and poisson random generator, fast sort and fast median. All of these functions, with the exceptions of spline2, exist in yorick or the yutils package, but these versions are 2 to 10x faster, being specialized for 2d arrays (hence the name imutil). 64 bits safe.
- Dependencies: none (the check-plug requires the yutils package)
- Known to compile on OsX and Linux.
- Grab it here or install the binaries with pkg_mngr
- Install with
yorick -batch make.i; make; make check; make install - Author: F.Rigaut, 11/2004.
SOY: Sparse Operations with Yorick
- Summary: Provides functions for fast sparse matrix operations.
- Dependencies: None.
- Known to compile on OSX, Linux...
- Grab it here or install the binaries with pkg_mngr (includes installation instructions).
- Author: R.Flicker
yao: Adaptive Optics simulation plugin
- Summary: Adaptive Optics simulation tool. Includes a gtk GUI.
- Dependencies: FFTW3, yutils, imutil
- Known to compile on OsX and Linux
- Grab it here or install the binaries with pkg_mngr
- Install with
yorick -batch make.i; make; make check; make install - Author: F.Rigaut
hdf5
- Summary: Simple wrapper to the Hierarchical Data Format 5 Libraries
- Dependencies: HDF5 libraries v1.6.4 or newer
- Known to compile on OsX, Linux and IRIX64
- Grab it here or install the binaries with pkg_mngr.
- Install with
yorick -batch make.i; make; make check; make install - Author: F.Rigaut
ycatools
- Summary: Wrapper to the EPICS CATOOLS (channel access tools)
- Dependencies: epics 3.14
- Known to compile on OsX and Linux
- Grab it here
- Install with
yorick -batch make.i; make; make check; make install - Author: F.Rigaut