Difference between revisions of "Configuring and running FIA"

From Flametree Technologies
Jump to navigation Jump to search
 
(38 intermediate revisions by the same user not shown)
Line 3: Line 3:
 
==Calling FIA from the command line==
 
==Calling FIA from the command line==
  
This option requires that you supply (i) data files, and (ii) a configuration file. The mechanics of doing this are shown in the following links:
+
The simplest and quickest way to get going with FIA is to run in stand-alone mode from the command prompt. This requires
  
Data files for FIA
+
* data files;
 +
* a configuration file
 +
 
 +
With these you can start generating attribution analyses immediately, using the supplied <tt>fia64</tt> program.
 +
 
 +
<tt>fia64</tt> is a simple program that reads in the supplied data and configuration settings, passes them through to the Flametree engine using its API, and generates reports.
 +
 
 +
All output is in the form of Excel or CSV files, as specified in the configuration settings.
 +
 
 +
[[Setting up data files|Setting up data files]]
  
 
[[Configuration files|Setting up a configuration file]]
 
[[Configuration files|Setting up a configuration file]]
Line 17: Line 26:
 
==Calling FIA from code==
 
==Calling FIA from code==
  
This option requires that you supply (i) data as in-memory arrays, (ii) calls to configuration functions that set up how you want to run the analysis, and (iii) suitable code to call FIA from your coding environment.
+
To call FIA from code, the information required is almost exactly the same as for stand-alone mode. The main differences are
 +
 
 +
* data must be supplied as in-memory arrays rather than CSV files, using string_matrix() structures
 +
* configuration settings are assigned using function calls, rather than by assinging values in a configuration file
 +
* some code is required to pull everything together.
 +
 
 +
In general, a program that calls FIA has the following form:
 +
 
 +
* Required program dependencies are loaded
 +
* FIA data structures are loaded
 +
* The program is initialized, via a call to FIA_init(). This ensures that all variables are assigned appropriate default values if not set by the user.
 +
* Variables and data are initialized via calls to FIA_set_matrix, FIA_set_string, FIA_set_double, FIA_set_integer
 +
* FIA is run via a call to FIA_run()
 +
* Results are either written to disk as reports, or read back into a string_matrix structure via a call to FIA_get_matrix for subsequent use elsewhere.
 +
 
 +
===Languages supported===
 +
 
 +
[[Calling FIA from Python|Calling FIA from Python]]
 +
 
 +
[[Calling FIA from Java|Calling FIA from Java]]
 +
 
 +
[[Calling FIA from Java|Calling FIA from Java]]
 +
 
 +
If the language you wish to use is not shown here, please contact Flametree support.
 +
 
 +
===API constants===
 +
 
 +
Values of the configuration constants are supplied in file <tt>FIA_API_CONSTANTS.py</tt> (for Python), <tt>FIA_API_CONSTANTS.cs</tt> (for C#), and <tt>FIA_API_CONSTANTS.java</tt> (for Java). These files are always supplied with the run-time files for FIA.
 +
 
 +
[[API constants|Using API constants]]

Latest revision as of 06:13, 20 August 2021

FIA can be configured in two ways, depending on how you want to call the program:

Calling FIA from the command line

The simplest and quickest way to get going with FIA is to run in stand-alone mode from the command prompt. This requires

  • data files;
  • a configuration file

With these you can start generating attribution analyses immediately, using the supplied fia64 program.

fia64 is a simple program that reads in the supplied data and configuration settings, passes them through to the Flametree engine using its API, and generates reports.

All output is in the form of Excel or CSV files, as specified in the configuration settings.

Setting up data files

Setting up a configuration file

Configuration settings

Running FIA from Windows

Runng FIA from Linux

Calling FIA from code

To call FIA from code, the information required is almost exactly the same as for stand-alone mode. The main differences are

  • data must be supplied as in-memory arrays rather than CSV files, using string_matrix() structures
  • configuration settings are assigned using function calls, rather than by assinging values in a configuration file
  • some code is required to pull everything together.

In general, a program that calls FIA has the following form:

  • Required program dependencies are loaded
  • FIA data structures are loaded
  • The program is initialized, via a call to FIA_init(). This ensures that all variables are assigned appropriate default values if not set by the user.
  • Variables and data are initialized via calls to FIA_set_matrix, FIA_set_string, FIA_set_double, FIA_set_integer
  • FIA is run via a call to FIA_run()
  • Results are either written to disk as reports, or read back into a string_matrix structure via a call to FIA_get_matrix for subsequent use elsewhere.

Languages supported

Calling FIA from Python

Calling FIA from Java

Calling FIA from Java

If the language you wish to use is not shown here, please contact Flametree support.

API constants

Values of the configuration constants are supplied in file FIA_API_CONSTANTS.py (for Python), FIA_API_CONSTANTS.cs (for C#), and FIA_API_CONSTANTS.java (for Java). These files are always supplied with the run-time files for FIA.

Using API constants