Next Previous Up Contents
Next: How to fit spectra using Yafit
Up: Top
Previous: Introduction


2 Invoking Yafit commands

Yafit is a java program, usually distributed as the file yafit.jar. It requires a Java Runtime Environment (JRE) version 1.4 or later to run.

The package comprises a number of different tasks; tasks are called things like fit and plotobs. They are invoked by giving the task name followed by a set of arguments, usually in the form name=value. Each command and its arguments are described in detail in Appendix A

There are two ways of invoking the program:

Directly with java:
    java -jar yafit.jar <task-name> <task-args>
With script (unix only):
    yafit <task-name> <task-args>
The yafit script is a convenience for running on unix-like operating systems: if you don't have the script, you can extract it from the jar file like this:
   unzip yafit.jar yafit
   chmod +x yafit
To run the script file, you must have the java command on your path, and the yafit script should be in the same directory as yafit.jar.

Invoking the program with the -help flag gives a summary of the available tasks:

   yafit -help


Usage:
   yafit [-help] [-version] [-verbose] [-debug] [-bench]
         <task-name> <task-args>

   yafit <task-name> -help

   Known tasks:
      fit
      funcs
      copymodel
      tableobs
      plotmodel
      plotobs



Usage information (a list of parameters) for each individual task can be obtained by supplying the -help flag after the name of the task itself, e.g.
   yafit fit -help
Full help for each command is given in the reference section, Appendix A.


Next Previous Up Contents
Next: How to fit spectra using Yafit
Up: Top
Previous: Introduction

Yafit - Yet Another Fitting Tool
User Guide