Difference between revisions of "GSFIT Installation"

From EOVSA Wiki
Jump to: navigation, search
(Created page with "We have developed a IDL-widget(GUI)-based spectral fitting package called [http://www.ovsa.njit.edu/wiki/index.php/EOVSA_Data_Analysis_Tutorial#GSFIT_GUI_Application ''gsfit''...")
 
(GSFIT SSW_UPGRADE Installation)
 
(34 intermediate revisions by the same user not shown)
Line 1: Line 1:
We have developed a IDL-widget(GUI)-based spectral fitting package called [http://www.ovsa.njit.edu/wiki/index.php/EOVSA_Data_Analysis_Tutorial#GSFIT_GUI_Application ''gsfit''], which provides a user-friendly display of EOVSA image cubes and an interface to fast fitting codes (via platform-dependent shared-object libraries).  Fits to individual spectra can be done quickly for manual investigation, while parallel/multi-core batch processing of selected blocks of data can also be performed using a command prompt application called [http://www.ovsa.njit.edu/wiki/index.php/EOVSA_Data_Analysis_Tutorial#GSFITCP_Batch_Mode_Application ''gsfitcp'']. A helper routine called [http://www.ovsa.njit.edu/wiki/index.php/EOVSA_Data_Analysis_Tutorial#GSFIVIEW_GUI_Application ''gsfitview''] allows further display and investigation of the fitting results.
+
[https://github.com/Gelu-Nita/GSFIT GSFIT] is an IDL-widget(GUI)-based spectral fitting package that provides a user-friendly display of [http://www.ovsa.njit.edu/ EOVSA] image cubes and an interface to fast fitting codes (via platform-dependent shared-object libraries).  Fits to individual spectra can be done quickly for manual investigation using a GUI application called [http://www.ovsa.njit.edu/wiki/index.php/GSFIT_Help GSFIT], while parallel/multi-core batch processing of selected blocks of data can also be performed using a command prompt application called [http://www.ovsa.njit.edu/wiki/index.php/GSFITCP_Help GSFITCP]. A helper routine called [http://www.ovsa.njit.edu/wiki/index.php/GSFITVIEW_Help GSFITVIEW] allows further display and investigation of the fitting results.
 +
For detailed information about these applications, please visit the pages linked below.
 +
*[[GSFIT Help]]
 +
*[[GSFITCP Help]]
 +
*[[GSFITVIEW Help]]
  
===GSFIT Linux / Mac OS Requirements===
+
Platform specific installation instructions for the GSFIT package are provided on this page.
 +
 
 +
=GSFIT IDL Version Requirements (All Platforms)=  
 +
<span style="color:red">'''IDL8.4, or higher, is needed for running any of the applications included in this package'''</span>.
 +
 
 +
=GSFIT Linux / Mac OS Requirements=
 
On Mac and Unix platforms, the gfortran compiler must be also installed to allow automatic compilation of the source code located in the ..//gsfit/unix directory, in order to generate a series of shared libraries, when gsfit is launched for the first time. WARNING: For this action to be successfully completed, the user must have writing rights to the ..//gsfit/unix directory.
 
On Mac and Unix platforms, the gfortran compiler must be also installed to allow automatic compilation of the source code located in the ..//gsfit/unix directory, in order to generate a series of shared libraries, when gsfit is launched for the first time. WARNING: For this action to be successfully completed, the user must have writing rights to the ..//gsfit/unix directory.
  
===GSFIT Windows OS Requirements===
+
'''If needed, instructions for installing the gfortran compiler may be found [http://www.lapk.org/gfortran/gfortran.php?OS=7 here].'''
 +
 
 +
=GSFIT Windows OS Requirements=
 
The GSFIT package is distributed along with a set of dynamic link libraries located in the ..//gsfit/win subfolder, which have been compiled assuming a WIN64 architecture. For Win32, please contact us to inquire about alternative options.
 
The GSFIT package is distributed along with a set of dynamic link libraries located in the ..//gsfit/win subfolder, which have been compiled assuming a WIN64 architecture. For Win32, please contact us to inquire about alternative options.
  
===GSFIT SSW_UPGRADE Instalation===
+
=GSFIT SSW_UPGRADE Installation=
The release version of the IDL GSFIT package is intended to be distributed through the SSW IDL repository [https://www.lmsal.com/solarsoft/].  
+
The release version of the IDL GSFIT package is intended to be distributed through the [https://www.lmsal.com/solarsoft/ SSW IDL repository].  
 
Although installed as a stand-alone package, the GSFIT code relies on a series of IDL support routines that are part of the gx_simulator package. Therefore, in addition to installing the gsfit package , the gx_simulator package must be also installed. This installation can be performed by issuing an upgrade command, i.e.
 
Although installed as a stand-alone package, the GSFIT code relies on a series of IDL support routines that are part of the gx_simulator package. Therefore, in addition to installing the gsfit package , the gx_simulator package must be also installed. This installation can be performed by issuing an upgrade command, i.e.
  
Line 15: Line 26:
 
</pre>
 
</pre>
  
===GSFIT Manual SWW Installation and Setup===
+
=GSFIT SSW Instrument Setup=
However, if as of today the GSFIT package has not been yet released through SSW, you may perform a manual install by copying the directory structure located at  https://github.com/Gelu-Nita/GSFIT to your local machine SSW  directory, $ssw/packages/gsfit/'
+
After the SSW installation is upgraded to include gsfit and gx_simulator packages, to ensure proper functionality, one should also edit the sswidl.bat (on Windows platforms) or cshrc (on Unix or Mac platforms) scripts to include gx_simulator and gsfit in the SSW_INSTR path declaration, i.e.
If such manual installation is performed, the $ssw/gen/setup/setup.ssw_env script must be edited by adding or altering the following lines:
+
<pre>
+
setenv SSW_GSFIT $SSW_PACKAGES/gsfit$
+
 
+
setenv SSW_PACKAGES_INSTR "packages/gsfit [...]"
+
 
+
setenv SSW_PACKAGES_ALL "$SSW_GSFIT [...]"
+
</pre>
+
 
+
where [...] denote the definitions already existent in the original setup.ssw_env script.
+
 
+
===GSFIT SSW Instrument Setup===
+
Please note that, regardless the method chosen to install any of these two packages, to ensure proper functionality, one should make sure that sswidl.bat (on Windows platforms) or cshrc (on Unix or Mac platforms) scripts are properly updated such as to include gx_simulator and gsfit in the SSW_INSTR path declaration, i.e.
+
 
<pre>
 
<pre>
 
set SSW_INSTR=gx_simulator, gsfit [...]  
 
set SSW_INSTR=gx_simulator, gsfit [...]  
Line 35: Line 33:
 
where [..] denotes any other SSW packages already installed.
 
where [..] denotes any other SSW packages already installed.
  
===GSFIT Manual Stand-Alone Installation===
+
=GSFIT Manual Stand-Alone Installation=
 
Although '''not reccomended''', one may in principle choose to install the gsfit and gx_simulator packages in standalone directories that are not part of the SSW repositories. However if this (not recommended) option is used, the gsfit and gx_simulator paths should be explicitly added to the IDL !path global variable, i.e.   
 
Although '''not reccomended''', one may in principle choose to install the gsfit and gx_simulator packages in standalone directories that are not part of the SSW repositories. However if this (not recommended) option is used, the gsfit and gx_simulator paths should be explicitly added to the IDL !path global variable, i.e.   
  

Latest revision as of 11:58, 27 May 2019

GSFIT is an IDL-widget(GUI)-based spectral fitting package that provides a user-friendly display of EOVSA image cubes and an interface to fast fitting codes (via platform-dependent shared-object libraries). Fits to individual spectra can be done quickly for manual investigation using a GUI application called GSFIT, while parallel/multi-core batch processing of selected blocks of data can also be performed using a command prompt application called GSFITCP. A helper routine called GSFITVIEW allows further display and investigation of the fitting results. For detailed information about these applications, please visit the pages linked below.

Platform specific installation instructions for the GSFIT package are provided on this page.

GSFIT IDL Version Requirements (All Platforms)

IDL8.4, or higher, is needed for running any of the applications included in this package.

GSFIT Linux / Mac OS Requirements

On Mac and Unix platforms, the gfortran compiler must be also installed to allow automatic compilation of the source code located in the ..//gsfit/unix directory, in order to generate a series of shared libraries, when gsfit is launched for the first time. WARNING: For this action to be successfully completed, the user must have writing rights to the ..//gsfit/unix directory.

If needed, instructions for installing the gfortran compiler may be found here.

GSFIT Windows OS Requirements

The GSFIT package is distributed along with a set of dynamic link libraries located in the ..//gsfit/win subfolder, which have been compiled assuming a WIN64 architecture. For Win32, please contact us to inquire about alternative options.

GSFIT SSW_UPGRADE Installation

The release version of the IDL GSFIT package is intended to be distributed through the SSW IDL repository. Although installed as a stand-alone package, the GSFIT code relies on a series of IDL support routines that are part of the gx_simulator package. Therefore, in addition to installing the gsfit package , the gx_simulator package must be also installed. This installation can be performed by issuing an upgrade command, i.e.

IDL> ssw_upgrade,/gsfit,/gx_simulator,/gen,/spawn,/loud,/passive_ftp 

GSFIT SSW Instrument Setup

After the SSW installation is upgraded to include gsfit and gx_simulator packages, to ensure proper functionality, one should also edit the sswidl.bat (on Windows platforms) or cshrc (on Unix or Mac platforms) scripts to include gx_simulator and gsfit in the SSW_INSTR path declaration, i.e.

set SSW_INSTR=gx_simulator, gsfit [...] 

where [..] denotes any other SSW packages already installed.

GSFIT Manual Stand-Alone Installation

Although not reccomended, one may in principle choose to install the gsfit and gx_simulator packages in standalone directories that are not part of the SSW repositories. However if this (not recommended) option is used, the gsfit and gx_simulator paths should be explicitly added to the IDL !path global variable, i.e.

and explicitly add this path to your IDL path structure.

IDL> !path='..//gsfit/idl:'+!path
IDL> !path='..//gx_simulator/idl:'+!path

where ../ should be replaced with the explicit paths to the respective local machine repositories.