hoe : Subaru HDS++ OPE file Editor

2025.06.13: Release of ver.6.0.3 (Important Update)

We have released version 6.0.3, which fixes issues caused by changes to the reference URLs for instrument configuration files.
In versions prior to 6.0.3, HOE fails to start properly for HSC and IRCS due to .ini files not being loaded.
The Linux version is currently under development. Please use the Windows or macOS version to prepare for your observations.

Subaru HDS++ OPE file Editor (hoe)

Subaru HDS++ OPE file Editor (hoe) is an application software to prepare observations with High Dispersion Spectrograph (HDS) and several other instruments of 8.2-m Subaru Telescope, NAOJ. Its fundamental purpose is to make operation (OPE) files for your observations. Furthermore, it works as a finding chart (FC) creator, an Echelle format simulator (EFS), an exposure time calculator (ETC), and a query tool for archiving databases.
Many of its functions are over-wrapped with those of hskymon. Please also refer the page of hskymon.

Currently hoe supports observations with

HDS (High Dispersion Spectrograph)
IRCS (InfraRed Camera and Spectrograph).

Detailed explanation in Subaru/IRCS page
How-To Movie in youtube [1/2] (for Base OPE)
How-To Movie in youtube [2/2] (for Plan OPE)

HSC (Hyper Suprime-Cam). New!

How-To Movie in youtube

IRD (InfraRed Doppler).
This page introduces how to prepare observation of Subaru/HDS using hoe.

As fundamental philosophy, only OPE files directly outputted by hoe can be used in HDS observation. To avoid unnecessary troubles you should not edit OPE files in text editors. Please exchange .hoe files with your support astronomers in your obs preparation phase.

Contents
Download
File types for input object list CSV (comma separated) list OPE file Non-Sidereal Tracking File (TSC format) Non-Sidereal Tracking File (JPL HORIZONS format)
Types of OPE files which can be created Base OPE Plan OPE
Main Window for HDS (ver4.1.0) Menu bar General TAB SV/AG TAB HDS TAB Main Target TAB Standard TAB DB / Finding Chart TAB DB / Main Target TAB EFS Line List TAB ETC TAB
Obs. Plan Editor for HDS (ver4.1.0) Obs. Plan Editor Observational Tasks Plots for Obs. Plan
Other Tools Echelle Format Simulator (EFS) Exposure Time Calculator (ETC) PDF Finding Chart for all targets in the list Sky Monitor Elevation Plot Window Finding Chart
FAQ / How to use Basic Chart Flow : How to make an OPE file How to make an HDS observing plan How to make a plan for service obs Observation with I2-Cell Observation with Image Slicer High proper motion stars Non-sidereal tracking How to compile from source code (UNIX)

Download

latest release = ver6.0.3 for Windows, Mac and Source. Linux version is not ready. (6/13/2025) [Change Log]
	macOS installer image 10.9 Mavericks or later; 64bit If you get a warning from Gatekeeper, please start it with "Open" popped up by CTRL+Click.	.dmg (65.5MB)
	Windows 64bit installer Windows 10 or later	.exe (23.7MB)
	linux deb (64bit) (Gtk+2) for Ubuntu 18.4LTS	.deb (1.7MB)
	linux rpm (64bit) (Gtk+2) for CentOS 7	.rpm (1.9MB)
	source code Common for UNIX/Windows/macOS. License= GPL3 How to install in UNIX	.tar.gz (3.5MB)

-

You can download the latest version via github.

     %  git clone https://github.com/chimari/hoe.git

File types for input object list

To make an OPE file you must prepare your target list.
Though you can build it w/o any input files in Main Target TAB of hoe, the easiest way to load the following types of files.

CSV (comma separated) list

You can use CSV list text files for your target list like

    Object Name, RA(hhmmss.ss), Dec(ddmmss.ss), Equinox, Free comments

. For example,

    HD94028     ,105128.1 ,+201639.0 ,2000,  [comments]
    BD+36 2165  ,111248.0 ,+354343.9 ,2000,  Mv=8.4  Fe/H=-2
    HD97916     ,111554.2 ,+020512.1 ,2000,  Mv=10.2 Fe/H=-2
    BD+51 1696  ,114635.2 ,+505254.7 ,2000   
    BD-13 3442  ,114650.7 ,-140643.5 ,2000,
          ....................................

Load CSV list files : Menu→File→Open(Merge) List.

Or, you can also load CSV files including magntudes of each target in their 5th column.

        HD94028     ,105128.1 ,+201639.0 ,2000,  8.2, [comments]  300x1
        BD+36 2165  ,111248.0 ,+354343.9 ,2000,  9.8, 480x1
        HD97916     ,111554.2 ,+020512.1 ,2000,  9.2, 420x1
        BD+51 1696  ,114635.2 ,+505254.7 ,2000,  9.9, 480x1
        BD-13 3442  ,114650.7 ,-140643.5 ,2000, 10.3, 600x2
          ....................................

Please select the type of the CSV list in the checkbox of the popped up dialog.

OPE file

You can use OPE files for Subaru Gen2 system as your target list (Menu → File → Import List form OPE).

Each target must be defined with its OBJECT (name), RA, DEC, and EQUINOX within <PARAMETER_LIST> section of OPE files as follows.

       <PARAMETER_LIST>  
       TGT_V5668Sgr=OBJECT="V5668 Sgr" RA=183656.87 DEC=-285539.30 EQUINOX=2000.00
       TGT_HD164536=OBJECT="HD164536" RA=180238.62 DEC=-241519.39 EQUINOX=2000.00
       TGT_sigSgr=OBJECT="sig Sgr" RA=185515.93 DEC=-261748.21 EQUINOX=2000.00
       TGT_HD149757=OBJECT="HD149757" RA=163709.54 DEC=-103401.52 EQUINOX=2000.00
       TGT_HD184915=OBJECT="HD184915" RA=193653.45 DEC=-070138.92 EQUINOX=2000.00
       TGT_V339Del=OBJECT="V339 Del" RA=202330.73 DEC=+204604.10 EQUINOX=2000.00
          ....................................
       </PARAMETER_LIST>

Non-Sidereal Tracking File (TSC format)

Non-Sidereal tracking files for TSC are also loadable.

    #1 Ceres on July 26 HST
    +00.0000 +00.0000 ON% +0.000
    UTC Geocentric Equatorial Mean Polar Geocentric
    ABS
    TSC
    500
    20010727000000.000 185406.057 -303521.41   1.953782861 2000.0000
    20010727003000.000 185405.055 -303524.50   1.953904593 2000.0000
    20010727010000.000 185404.053 -303527.59   1.954026432 2000.0000
    20010727013000.000 185403.051 -303530.67   1.954148379 2000.0000
    20010727020000.000 185402.050 -303533.75   1.954270432 2000.0000
    20010727023000.000 185401.049 -303536.82   1.954392592 2000.0000
    20010727030000.000 185400.049 -303539.90   1.954514860 2000.0000
                   ..........................

Please put TSC files in an appropriate directory (maybe in the same directory where your OPE files locate) and load them from the menu.
Files must follow the format described in this page.
You should use Geocentric coordinate in TSC files. They would be automatically converted into topocentric in the program. Therefore, coordinates displayed in Main Target TAB or other parts of hoe would not be exactly same as ones described in Non-Sidereal tracking files.

Non-Sidereal Tracking File (JPL HORIZONS format)

hoe can also load NASA JPL HORIZONS output files.
Please note that you should set

    "Ephemeris Type" = OBSERVER
    "Observer Location" = Geocentric
    "Table Settings" = 1. Astrometric RA & Dec, 20. Observer range

for your input. Either calendar date or JD is acceptable for date format.
hoe can convert HORIZONS files into the TSC format (Menu → File → Non-Sidereal → Convert HORIZONS to TSC).

Types of OPE files which can be created

hoe can create two type of OPE files -- Base OPE or Plan OPE.
Basically we recommend to make a Plan OPE for your obs. to grasp entire flow of your observation.

Base OPE

Base OPE is a simple OPE file describing a list of observation commands for each target and for each setup.
If you have many targets and their order should be determined during your obs., you can use this type of OPE files for your obs.

Base OPE can be created by Menu → File → Write Base OPE.

       .......................
       #######  NonStd-1 2x1binning  #######

       # [1] V5668 Sgr    ,    Vmag=5
       #    NonStd-1 2x1binning / SV Guide / ImR=No
       SetupField Guide=SV Mode=SemiAuto $DEF_PROTO $TGT_V5668Sgr ReadRegion=200 CalcRegion=60 Exptime_SV=1000 IMGROT_FLAG=0 IS_FLAG=1 $SV_IS_X $SV_IS_Y $G_PARA ReadArea=Part
       GetObject IS_FLAG=1 $DEF_SPEC Exptime=300 SVIntegrate=1 $TGT_V5668Sgr
       GetObject IS_FLAG=1 $DEF_SPEC Exptime=300 SVIntegrate=1 $TGT_V5668Sgr
       GetObject IS_FLAG=1 $DEF_SPEC Exptime=300 SVIntegrate=1 $TGT_V5668Sgr

       # [2] HD164536    ,    Vmag=7.40  O7.5V
       #    NonStd-1 2x1binning / SV Guide / ImR=No
       SetupField Guide=SV Mode=SemiAuto $DEF_PROTO $TGT_HD164536 ReadRegion=200 CalcRegion=60 Exptime_SV=1000 IMGROT_FLAG=0 IS_FLAG=1 $SV_IS_X $SV_IS_Y $G_PARA ReadArea=Part
       GetObject IS_FLAG=1 $DEF_SPEC Exptime=600 SVIntegrate=1 $TGT_HD164536

       # [3] sig Sgr    ,    Vmag=2.058  B2V
       #    NonStd-1 2x1binning / SV Guide / ImR=No
       SetupField Guide=SV Mode=SemiAuto $DEF_PROTO $TGT_sigSgr ReadRegion=200 CalcRegion=60 Exptime_SV=1000 IMGROT_FLAG=0 IS_FLAG=1 $SV_IS_X $SV_IS_Y $G_PARA ReadArea=Part
       GetObject IS_FLAG=1 $DEF_SPEC Exptime=60 SVIntegrate=1 $TGT_sigSgr
       GetObject IS_FLAG=1 $DEF_SPEC Exptime=60 SVIntegrate=1 $TGT_sigSgr
       ....................................

Plan OPE

In Plan OPE, all commands are lined up following your observing plan through one night.
Elapsed times for each commands are calculated and target times are labeled with commands.

You can create this type of OPE files using Obs. Plan Editor.

       .................
       ### SunSet 19:01, Twilight(18deg) 20:10   8/11/2016 ###

       ## [19:26]
       ###### Focus SV #####
       FocusSVSequence $DEF_COMMON
       SetStarSize $DEF_PROTO SEEING=0.60


       ## [19:31]
       ###### "sig Sgr", 60sec x2,  Setup-3 : NonStd-2 2x1bin, [SV Guide] #####
       # Vmag=2.058  B2V
       SetupField Guide=SV Mode=SemiAuto $DEF_PROTO $TGT_sigSgr ReadRegion=200 CalcRegion=60 Exptime_SV=1000 IMGROT_FLAG=0 IS_FLAG=1 $SV_IS_X $SV_IS_Y $G_PARA ReadArea=Part
       GetObject IS_FLAG=1 $DEF_SPEC Exptime=60 SVIntegrate=1 $TGT_sigSgr
       GetObject IS_FLAG=1 $DEF_SPEC Exptime=60 SVIntegrate=1 $TGT_sigSgr

       ## [19:37]
       ###### "ASASSN-16ig", 300sec x3,  Setup-3 : NonStd-2 2x1bin, [SV Guide] #####
       SetupField Guide=SV Mode=SemiAuto $DEF_PROTO $TGT_ASASSN16ig ReadRegion=200 CalcRegion=60 Exptime_SV=1000 IMGROT_FLAG=0 IS_FLAG=1 $SV_IS_X $SV_IS_Y $G_PARA ReadArea=Part
       GetObject IS_FLAG=1 $DEF_SPEC Exptime=300 SVIntegrate=1 $TGT_ASASSN16ig
       GetObject IS_FLAG=1 $DEF_SPEC Exptime=300 SVIntegrate=1 $TGT_ASASSN16ig
       GetObject IS_FLAG=1 $DEF_SPEC Exptime=300 SVIntegrate=1 $TGT_ASASSN16ig

       ## [19:57]
       ###### Setup Change (Cross Scan), Setup-1 : NonStd-1 2x1bin #####
       SetupOBE $DEF_SPEC SLIT_LENGTH=30000
       SetupOBE $DEF_SPEC FILTER_1=Free FILTER_2=SC46 CROSS_SCAN=18560
       ...................

Main Window for HDS (ver4.1.0)

Menu bar

File	Open List	Open CSV text list in local system. Maximum object number is 5000.
	Merge List	Merge CSV text list in local system.
	Merge List from OPE	Import target list from an OPE file.
	Merge List from Config (.hoe)	Import target list from an hoe file.
	Non-Sidereal	Merge TSC file	Merge a Non-Sidereal target described in telescope tracking file (TSC format).
		Merge JPL HORIZONS file	Merge a Non-Sidereal target described in JPL HORIZONS format.
		Convert HORIZONS to TSC	Convert and save JPL HORIZONS format into TSC tracking file.
	Initialize Target List	Initialize the target list in Main Target TAB.
	Write Base OPE	Create a Base OPE (Simple OPE files describing a list of observation commands for each target) file.
	Upload OPE	Upload an OPE (or other) file to the summit Gen2 system (sumda:/home/oXXXXX/Procedure/). This function is available only inside of Subaru Telescope Network.
	Write PROMS Target List	Write a target list text file for the Subaru Telescope Proposal Management System (PROMS). Magnitudes should be added to all of your targets before using this function.
	Load Config	Load all contents of hoe which saved in a *.hoe file.
	Save Config	Save all working contents into a *.hoe file.
	Change Instrument	Change the instrument for your observation. Be aware that the observation plan in hoe will be initialized with this instrument change.
	Quit	Quit from the program. Save Font and Browser setups in General TAB into HOME$/.hoe. It will be referred at the next starting up.
Edit	Obs. Plan Editor	Start up Obs. Plan Editor to make a observation plan.
	Text Editor (Saved OPE)	Start up the text editor with a last saved OPE file. (This function is deprecated.)
	Text Editor (Select OPE)	Start up the text editor with a chosen OPE file. (This function is deprecated.)
Tool	PDF Finding Charts	Create a PDF file which includes a list of finding charts for all of your targets.
	Sky Monitor	Start up Sky Monitor. Its function is almost equivalent to that of hskymon.
Database	Data Archive List Query	SMOKA	Batched queries with SMOKA for the target list in Main Target TAB. This is a same one involved in hskymon.
		HST archive	Batched queries with HST archive for the target list in Main Target TAB.
		ESO archive	Batched queries with ESO archive for the target list in Main Target TAB.
		Gemini archive	Batched queries with Gemini telescope archive for the target list in Main Target TAB.
	Catalog Matching	SIMBAD	Batched queries with SIMBAD. A brightest (or nearest if no one has magnitude info.) object within a specified search radius would be selected as a counterpart. So, you should narrow your search radius as long as the reliability of target coordinates permits. Magnitude information will be added into the list in Main Target TAB. The queried result will be displayed in DB / Main Target TAB.
		NED	Batched queries with SIMBAD. This query never add Magnitude information into the list.
		LAMOST DR3	Batched queries with LAMOST. This query never add Magnitude information into the list.
		GSC 2.3	Batched queries with Guide Star Catalog. Magnitude information will be added into the list in Main Target TAB.
		PanSTARRS-1	Batched queries with PanSTARRS catalog. Magnitude information will be added into the list in Main Target TAB. Please be aware that a same object tends to be listed with two or more different coordinates in PanSTARRS catalog.
		SDSS DR15	Batched queries with SDSS catalog. Magnitude information will be added into the list in Main Target TAB.
		GAIA DR2	Batched queries with GAIA catalog. Magnitude information will be added into the list in Main Target TAB.
		Kepler Input Catalog	Batched queries with Kepler Input Catalog. Magnitude information will be added into the list in Main Target TAB.
		2MASS	Batched queries with 2MASS catalog. Magnitude information will be added into the list in Main Target TAB.
	Param for Standard	Parameters for finding standard stars (for Standard Locator/Rapid Rotator/Mid-IR Standard in Object List Window). Sky Area : delta RA and delta Dec. from the target, used in Standard Locator/Rapid Rotator/Mid-IR Standard.
	Param for DB Query	Change search parameters for database query in Finding Chart Window.
HDS	EFS: Echelle Format Simulator	Start up Echelle Format Simulator (EFS).
	ETC: Exposure Time Calculator	Start Exposure Time Calculator (ETC) for a selected target in Main Target TAB. The result will be displayed in ETC TAB.
	Calc. S/N for all targets by ETC	Calculate S/N ratios at a specified wavelength order (default: the bluest order of the Red CCD) for all of targets in Main Target TAB, and add them into the list. Magnitudes should be added for targets before using this function. It assumes that all targets have a same specified spectral type.
	Set Default Guide/PA/Exp.	Set specified guide mode, PA with image rotator (ImR), and exposure time to all targets in Main Target TAB.
	Calc ExpTime using Mag.	Set exposure times for each targets in Main Target TAB to get a same S/N ratios (under shot noise limit). Magnitudes should be added for targets before using this function.
	SV Guide mode selection	Accessing to GAIA DR2 (recommended) or GSC 2.3 databases, hoe carries out the following operations for toall targets in Main Target TAB. Identify the brightest star within a specified circle as your target. If the star has a companion (comparable or brighter star within ∼5 arcsec), a caution for double star will be popped up. Check bright stars in SV FOV (∼40 arcsec including target acquisition error) If there are some bright stars around the target, set SV Guide to Safe mode. If not, set it to SemiAuto mode. This function automatically adds Mag info for all targets.
	Download LOG	Download a observation log file created by HDS Log Editor in the summit Gen2 system (sumda) after observation. This function is available only inside of Subaru Telescope Network.
Info	Check the latest ver.	Check the latest version of hskymon via network.
	About	About this program.

General TAB

General information about the observation must be input here.

Date is the date of the observation in HST (Hawaiian Standard Time in evening)
Though x nights specifies the duration of nights, Obs. Plan Editor (or other function in hoe) refers the first date for its calculation. It is better to set each date into Date if you have two or more nights and want to make a precise schedule of your observation.
ID and Pass are for the "o-account" of Gen2 system. If you don't have them, please skip them.
All passwords used in hoe will be saved into each user's HOME$/.hoe file (by ASCII text). Because they are not saved in each *.hoe file, you have to re-enter passwords after transferred *.hoe files to to other environment.
Base OPE shows a total exposure time for all listed targets and setups, and an estimated observation time (includes times for CCD read out, telescope slewing, target acquisitions, and start guiding).
If you changed CCD binning etc., please push Recalc button to get correct values.
For service programs, estimated obs. times must not exceed 4 hours.
Plan OPE shows the observation time created by Obs. Plan Editor. Here, all telescope slewing times are calculated considering their celestial positions (The Base OPE estimation just assumes that each target acquisition takes 300 sec for all targets).
Web Browser(only for UNIX; The default browser will be employed in Win or macOS) and Font will be saved into HOME$/.hoe at the end of the program. It will be referred at every starting up.

SV/AG TAB

Setups for SV (Slit Viewer) and AG (Auto Guider) are described here.

Usually you don't need to change the default parameters in this TAB.
Especially AG is never used in usual HDS observations.
If you observe targets fainter than ∼16 mag, it's better to input a longer SV exposure time (up to ∼5000msec).

HDS TAB

Setups for HDS are described here.

Wavelength Setup can stock HDS setups (max: 5) for your observation.
The left side check buttons should be turned ON, if you want to use the setup in your obs.
If you employ non-standard setups, you can create them in Non-Standard Setup (max: 4). Then select "NonStd-X" in Wavelength Setup.
CCD Binning is described as (spatial direction) x (spectral direction).
The border slit width for spectral x2 binning would be > 0.45arcsec = 225μm (2 pixel sampling).
If you employ Image Slicers, please set Slit Width=4.0, Length=60.0 (arcsec).
If you employ one of Standard setups, the order sort filter will be automatically selected.
However, you can remove the filter if you observe < 7000 Å with ADC (ADC cuts off photons at λ < 3600 Å, when your targets are not specially bright ones.).
In such case please change the filters manually.
For non-standard setups, you have to change the order sort filters manually.
For UV observations (λ < 3600 Å), you should use Blue Image Rotator (ImR) with Zenith mode in place of ADC.
If you employ I2 cell for your obs., please check I2.
The camera focus positions of spectrograph, Camera Z, are usually measured at before every observing run.
Sync button download and reflect their latest values.
Cross Scan Calculator calculates the color of collimator and the scan angle of cross disperser for a specified center wavelength.
Please use it when you create a non-standard setup.

Main Target TAB

Targets for the observation are described here.

The check buttons at the left end of the list are used for the elevation plot with target selection.
Magnitudes of targets can be added manually or automatically by batched database queries (Menu → Database → Catalog Matching).
This information is not required to create OPE files, but there are some merits.
- You can calculate S/N ratios for your each target (Menu → Update → Calc. S/N by ETC).
- The parameters for SV filters in SetupField are automatically added in the case of brighter targets.
- SV exposure times in SetupField are automatically set in Obs. Plan Editor.
- You can output a target list for the Subaru Telescope Proposal Management System (PROMS).
- If you calculate S/N ratios with Mag, you can output a setup request file for your Service proposal.
S/N is a signal-to-noise ratio (at a specific wavelength) calculated by ETC. This shows S/N ratio for one shot of the listed ExpTime, not considering the repeat of exposures. So if you want to know the total S/N of x N shots, you should time sqrt of N to the listed S/N ratio.
When the spectrum saturates, the background turns into pink.

ImRPA is Slit Position Angle (PA; North is up = 0 deg, East is up = +90 deg) for each target. This value is ignored when you do not use Image Rotator (ImR). In point source (stellar) observations, we usually do not use ImR. Please remind, therefore, slit PA (SV image) is always changing with telescope position and tracking. Please also remind that SV images are flipped by ImR.

PA = 0 deg (N is up) PA = 90 deg (E is up)

Guide is auto guide method for each target. You should use SV or SV[Safe] in most of cases.
The SV guide mode can be set automatically by using HDS→SV Guide mode selection →GAIA(recommended; or GSC). It will check bright stars in FoV, then select SV Guide mode.
For targets with large proper motions or extended targets, this function may not work properly.

No : No guide = tracking
AG : Guiding with an offset AG camera (we rarely use this mode in current time).
SV : SV (= Slit Viewer) guide (SemiAuto mode). This is the guiding with target itself on the slit. SemiAuto mode automatically detects the target as a brightest star in the 1st acquisition image of SV (FOV φ ∼ 1 arcmin) after the telescope arrived, then moves it to the center of the slit.

SV[Safe] : SV guide (Safe mode). This is SV guide manually selecting the target in the acquisition SV image for crowded regions or faint targets.

A target can apply SemiAuto mode
(The target is the brightest in FOV.) A target should use Safe mode
(Another brighter star is in FOV.)

Please check the setups, S1∼S5, which you employ for each target.
The button View → Plot at the bottom of the TAB pops up Elevation Plot Window.
The button View → FC at the bottom of the TAB pops up Finding Chart Window.
The button View → PM at the bottom of the TAB pops up Proper Motion Window.
The button View → ETC at the bottom of the TAB pops up a dialog for ETC.
The result of ETC will be displayed in ETC TAB.
You can browse the selected target in some web databases using an external web browser.
You can search standard stars around the selected target.
These functions are equivalent to those of hskymon.
The time displayed at the bottom-right corner of the TAB is the time used for calculation of Rise/Transit/Set in the list.

Standard TAB

The information for standard stars searched in Main Target TAB is displayed here.

Please sort by Dist. (distance from the selected target) and an appropriate one for your standard star.
If you want to add it into your Main Target, select a standard star and push + Main target button.

DB / Finding Chart TAB

Results queried in Finding Charts will be shown here.

+ Guide Star button will register a selected star as a guide star.
But, in HDS observation, a target itself is used for guiding (SV guide) usually. So, at this point, this function never affects to the case of HDS.
Save queried list to CSV file button on the upper-left corner outputs the result in this TAB to a CSV file.

DB / Main Target TAB

Results queried for all objects in Main Target TAB (Data archives or catalog matching) will be shown here.

← Show Detail button at the bottom will re-display detailed results for each target in DB / Finding Chart TAB.
Save queried list to CSV file button on the upper-left corner outputs the result in this TAB to a CSV file.
The drop down switch on the upper-right will switch the database displaying in the TAB.
For queries on data archives, only one latest result is memorized.

EFS Line List TAB

Line database displaying in EFS and ETC.

The buttons, -- Stellar Absorption, Nebular Emission, and High-z QSO --, are templates listed remarkable lines for each type of objects. Other lines can be added freely in the tree.
The red-shift of your target can be input in the entry at the bottom.

ETC TAB

Results for exposure time calculation will be shown here.

The pale and pink backgrounds correspond to Blue and Red CCD, respectively.
The orders saturated or affected by bad column will be noted in the most left column.
If you over-wrap your mouse cursor on the title bar, you can see parameters used for the calculation.
Re-calculation with different parameters (seeing etc.) can be done by Recalc ETC button on the upper-right.
Display Echelle Format button displays the Echelle format used for the calculation.

Obs. Plan Editor for HDS (ver4.1.0)

Obs. Plan Editor

Obs. Plan Editor is a tool to design an HDS observation plan through one night. It is popped up by Menu → Editor → Obs. Plan Editor.
By inserting tasks for observation, elapsed times will be automatically calculated.

The GUI of Obs. Plan Editor contains three parts (from upper to lower).
- Observational tasks
- HDS setup
- Plan for observation
.
After selected one HDS setup, then, you will insert tasks to the before line of the focused one.
By double-clicking on a task line, you can see and edit the parameters for the task.
If you want to add some back-up targets into your plan, add your back-up target to the plan as a normal task at once. Then, double-click the added task, and check Back up target? in its parameters.
This allows to insert commands for a back-up target. But its elapsed time will never be counted into a total observation time for your plan.
Each HDS setup (only checked for use in HDS TAB) is colored by its own color.
You don't need to insert tasks for HDS Setup change apparently by yourself. If the plan has Object (& Comparison) tasks with two or more HDS setups, appropriate Setup change tasks will be automatically inserted by Refresh button at the bottom of Obs. Plan Editor.
You should take one comparison (=Th-Ar) frame after changed HDS setup, if you don't have any special reason (This task is not inserted automatically.).
An OPE file followed by your observing plan (Plan OPE) can be created by the Menu of Obs. Plan Editor → File →Write Plan OPE.
File → Write Plan Text creates a text style output for your observing plan.
During using Obs. Plan Editor, File read/write from Main Window, Setup changes in HDS TAB, and add/remove objects in Main Target TAB (etc.) are disallowed.
If you want to do them, please close Obs. Plan Editor at once. You can resume designing works for your observing plan by restarting Obs. Plan Editor.
All parameters of your observing plan are saved into a *.hoe file (Menu → File → Save Config).
The starting time for the plan can be chosen from Evening or Specific time (mostly for the 2nd half obs.).

Observational tasks

The + buttons at the left end of each task TAB add a task into your observing plan.
Object/Setup/BIAS/Comarison/Flat refer HDS Setup. So, please select an appropriate setup before insert them.
Some of the tasks can execute during daytime (e.g., calibration frames). In that case, please check Daytime in each task. It will ignore to count its elapsed time.

Object (depends on HDS Setup)

Observation of astronomical targets.
Basically this task contains a pair of one SetupField (target acquisition and start guiding) and one or more GetObject (taking exposures) commands. But you can also choose only one of them.
If you select (All Objects) as target, "+ Object" button adds all targets in Main Target TAB to the plan, referring exposure times and guide mode in the list, and HDS setup in Obs. Plan Editor.

Focusing

Telescope focus adjustment.
This task uses FocusSVSequence or FocusAGSequence. However, because only SV is used in usual HDS observation, FocusSV should be selected in most of cases.

SetAzEl

This task move the telescope to a specific Azimuth and Elevation (by IntegGUI launcher command or manual operation in TWS).
If you find the cable wrap limit of the telescope (-270 < Az > +270) in your observing plan, please insert this task to avoid it.

Setup (depends on HDS Setup)

Commands for HDS setup changes.
HDS has two types of color setups for the pair of the collimator and the cross disperser (Blue & Red). If you want to change "color", you should select Full Change (elapsed time = 10min). If you change the wavelength setup within a same color setup, you should select Cross Scan (= 1min) to save time.
Changes for slit configuration should be also included in this task.
In usual case, you don't have to insert this command by yourself. By Refresh button at the bottom Obs Plan Editor (or at the time of saving Plan OPE) appropriate Setup tasks will be automatically inserted at appropriate points of your plan. However, this function does not support autmatic insertion of Comaprison or Focusing task which could accompany with HDS setup chnages. You should insert them by yourself, if you need.

I2Cell

Insert/Retract of I2-Cell in front of HDS slit.
In this task, the focus position of the telescope (z of M-2 position) is also moved.
This means that, in I2-Cell observations, you need to do FocusSV with and without I2-Cell.

BIAS (depends on HDS Setup)

Taking BIAS frames.
This task never depends on wavelength setup but depends on CCD binning.
Because we use the overscan region of the CCDs to measure their BIAS levels, BIAS frames are not so important in HDS observation. Usually, 5 BIAS frames are taken in evening and morning. After changed CCD binning, it is recommended to take one BIAS to confirm the binning setup.

Comparison (depends on HDS Setup)

Taking comparison (Th-Ar) frames.
It is better to ask telescope operators to setup the calibration (CAL) probe than to send a probe setup command from Gen2 during this task.
After changed HDS setup, you should take one comparison frame.

Flat (depends on HDS Setup)

Taking flat (Halogen lamp) frames.
It is better to ask telescope operators to setup the calibration (CAL) probe than to send a probe setup command from Gen2 during this task.
Flat frames should be taken in evening or/and morning usually. In case of NIR observation where CCD fringe patters get stronger, it is recommended to take flat frames before changing the setup.

Comment

Free comment lines.
The comment task can contain an elapsed time.
If you have any other tasks defined above (e.g., attach/detach of Image Slicers inside of the dome), use this task and elapsed time.

Plots for Obs. Plan

Plot and SkyMon buttons at the bottom of Obs. Plan Editor is popped up plotting tools for your Obs. Plan.

Elevation (etc.) plot

Select Plot = Observing Plan in Plot Window to see an elevation plot in entire of your Obs. Plan.

Sky Monitor

Select Mode = Plan (Object) or Plan (Time) in Sky Monitor, to see a telescope tracks in entire of your Obs. Plan.
If you find any in efficient telescope wraps, you should adjust them with SetAzel tasks.

Other tools

Echelle Format Simulator (EFS)

EFS can be popped up by Menu → HDS → EFS: Echelle Format Simulator (etc.).
If you added your remarkable lines in EFS Line List TAB, they will be shown in the EFS figure.

Same as EFS on WWW, it can also display Free Spectral Range.
The figure can be output to a PDF file.

Exposure Time Calculator (ETC)

The ETC dialog is popped up by Menu → HDS → ETC: Exposure Time Calculator (etc.).
The calculation algorithm is the same one used in WWW version of ETC.
The result comes up into ETC TAB or S/N column in Main Target TAB (if you used Menu → Update → Calc. S/N by ETC).

PDF Finding Chart for all targets in the list

This function is available by Menu → Tool → PDF Finding Charts.
Please enter the source and size of FC image, instruments etc. to create a PDF file in which FCs for all targets (one object / page) are contained. You can skip objects brighter than 10 mag for Service proposals. (Of course, this function works on objects with Mag.)

Sky Monitor

Sky Monitor is popped up by Menu → Tool → Sky Monitor etc.
Though it is a simple version of hskymon, it can show telescope tracks following your Obs. Plan.

Elevation Plot Window

Elevation Plot Window is popped up by View → Plot at the bottom of Main Target TAB (etc.).
Its function is almost equivalent to that of hskymon. It can show an elevation plot in entire of your Obs. Plan.

Finding Chart

FC can be popped up by View → FC in the bottom of Main Target TAB (etc.).
Its function is same as that of hskymon.

FAQ / How to use

Basic Chart Flow : How to make an OPE file

① Prepare your Target List in a CSV text file. (or create it in hoe)
⇓
② Read the list from hoe. (Menu → File → Open List)
⇓
③ Set Obs. Date etc. in General TAB. (If you don't have your Gen2 account info., skip it.)
⇓
④ Set HDS Setups in HDS TAB. Check one or more of S1∼5, which you will employ in your obs, for each target in the list of Main Target TAB. (Check the Echelle Format in EFS)
⇓
⑤ If necessary, search standard stars and add some of them to Main Target by + Main Target button at the bottom of Standard TAB.
⇓
⑥ Select SV Guide mode using HDS→SV Guide mode selection→GAIA or GSC). Mag info for all targets would also be added automatically.
⇓
⑦ Using ETC etc., determine exposure time and number for each target, input them into the list.
⇓		⇓
In case to create a simplest OPE (Base OPE) If you have many targets and their order should be decided during your obs., this would be better.		In case to create an OPE following your Obs. Plan (Plan OPE) This is recommended style to grasp entire of your observing night.
⇓		⇓
⑧ Save a Base OPE file by Menu → File→Write Base OPE.		⑧ Start up Obs. Plan Editor by Menu →Edit→Obs. Plan Editor, and design your Obs. Plan.
⇓		⇓
⇓		⑨ Save a Plan OPE by Obs. Plan Editor's Menu→File→Write Plan OPE. Then, close the Editor.
⇓		⇓
⑩ Save all working contents by Menu→File→Save Config into a *.hoe file.
⇓
⑪ Mail the saved *.hoe file to your Support Astronomer. SAs can reconstruct your obs. plan in their environment to allow smooth discussion about your obs.

How to make an HDS observing plan

Basic flow of HDS observation
1. Change HDS setup in evening. [Setup]
2. Take calibration (= CAL) frames in the order of BIAS → Flat. [BIAS] [Flat]
3. If you employ two or more HDS setups, repeat 1 → 2. In this case you should set the setup for your 1st target to the last.
  If you don't have enough time to finish your CAL frames, you can take them also in morning.
  If you use same binning, you can skip BIAS frames. Basically BIAS is not important in HDS data analysis.
4. Take a Comparison (= Th-Ar) frame with the setup for the 1st target and wait sunset. [Comparison]
5. Move the telescope to the azimuth of your 1st target. [SetAzEl]
  
  ------------- You should not count elapsed times for each task until here. -------------
6. You can start the 1st FocusSV 20 min after sunset. [Focus]
7. Start observation for bright targets (standards). [Object]
8. Then, arrange the order of your targets.
  If you pop up Sky Monitor with Obs. Plan Editor, you can see the picture of all targets' positions to determine the order easily.
  FocusSV and Comparison should be inserted depending on their demands. [Object] [Focus] [Comparison]
[task] points observational tasks to be used in each stage.
How often should I adjust the telescope focus (by FocusSV)
- At the beginning of the night
- Because the telescope temperature is dropping fast in evening, it is recommended to insert one FocusSV at ∼2 hours after the start time.
- One time around midnight.
- (If possible) one more time in morning.
is the basic FocusSV arrangement in HDS observation.
If you use I2-cell, you must do a pair of FocusSVs w/ and w/o I2-cell. The M-2 shift value by I2-cell insertion is roughly δz=+0.15 .
If you use Image Slicers, the M-2 focus would be shifted roughly δz=+0.5 . During HDS exposures, the shift δz=-0.45 would be added back to adjust the telescope focus point to the surface of the slicer element.
How often should I take Comparison (= Th-Ar) frames?
If you employ only one HDS setup through the night, evening, morning, and one more Comparison around midnight is enough (Of course, it depends on your desired absolute wavelength accuracy.).
When you change HDS setup, you should take one Comparison before change and another one after change.
How to change HDS setup?
1. Take a Comparison before changing the setup.
2. Change HDS setup
3. Take another Comparison
4. If the change includes changes of ADC/ImR and/or Image Slicers, you should do FocusSV after CAL shutdown.
is a basic way to change HDS setup.
If you change CCD binning mode, one BIAS to confirm the CCD readout is recommended.

How to make a plan for service obs.

Basic Flow for service obs.
1. Change HDS setup. [Setup]
  Because we cannot assume the setup used before, use "Full Change" for task's parameter.
2. If necessary, SA will do Focusing. [Focus]
  
  ------------- Hereafter elapsed times for each task should be counted in observation time of service program (4 hrs or less) -------------
3. Take Comparison [Comparison]
4. Arrange your targets [Object]
5. Take Comparison [Comparison]
  (You can remove one of them, if not necessary.)
  
  ------------- Until here elapsed times for each task should be counted in observation time of service program (4 hrs or less) -------------
6. Flat will be taken in evening or morning of observing night. [Flat]
Proposal for service obs.
- Remove all unnecessary targets from your list.
- Add Mag info for all of your targets.
- Calculate S/N ratios for all of your targets by ETC.
  (Above processes would not be effective for emission line objects.)
- In General TAB, Base OPE → Estimated Obs. Time must not exceed 4 hours for service programs. You should enter this value as your request hours to "5. Observing run" in your proposal.
- If your program includes some complicate process (e.g., frequent Th-Ar frames, insertion/retraction I2-Cell), create your plan by Obs. Plan Editor to check the total observation time.
- Menu → File → Write Service Request to create service request text file to be attached your proposal.

Observation with I2-Cell

Observations with I2-Cell (e.g., radial velocity monitoring of exoplanets) are used to take some spectra with and without I2-Cell, with a fixed wavelength setup.
In such case, you should check "I2 box" at the right end of your Setup line (usually with I2a or I2b) in HDS TAB.
You don't need to prepare two setups with and without I2-Cell.
Then, insert plans for IN and OUT of I2Cell to where you want in Obs. Plan Editor.
By Refresh button at the bottom of Obs. Plan Editor, [+i2] are inserted in the head lines of tasks taken with I2-Cell. Tasks to retract I2-Cell are automatically inserted before each calibration task.
Commands for flat frames with I2Cell will be automatically added to your OPE file when you set Flat task with a setup checked I2 box.
- With slit obs. : x1 with obs. slit, and x1 with 0.2 arcsec slit.
- With image slicer : x1 with slicer
Commands for a Th-Ar frame with 0.2 arcsec slit will be automatically added to your OPE file when you set Comparison task (in daytime) with a setup checked I2 box. This is only the case with slit obs.
The telescope (M2) focus position shifts about +0.15mm with I2-Cell.
Therefore, you should do two FocusSV (without and with I2-Cell) in usual I2-Cell observations.

Observation with Image Slicer

Please select an appropriate Image Slicer (IS) unit in your Setup line in HDS TAB.
The slit length and width will be automatically set to 4".0×60".0 in your OPE files. You do not need to edit them in the Setup line.

High proper motion stars

The FOV of HDS slit viewer is only ∼1 arcmin (and it will be narrower with image slicers) If your target has a high proper motion, therefore, the target coordinate must be adjusted.
In the main target list of hoe, you can add proper motions for your targets by the following ways.
- Add a target with the "+" button at the bottom of Main Target TAB. When you query the target coordinate with SIMBAD, its proper motion automatically added. You can see it in the dialog.
- Load your main target list and do SIMBAD database query with the Menu → Database → Catalog Matching → SIMBAD. If the target has proper motion registered in SIMBAD, it will be automatically registered in the main target list. Please check the box of Import proper motions via SIMBAD? in the query pop-up dialog.
- Select a target in Main Target TAB and push PM button at the bottom of TAB. Then, edit its proper motion manually in the popped up dialog.
If the target has a proper motion with δRA or δDec > 100 mas/yr, its coordinate in Main Target list displays with green.
In output OPE files, the coordinates for such objects will be automatically adjusted to the ones in observation date designated in General TAB.
```
          PMTGT_BarnardStar=OBJECT="Barnard Star" RA=175747.51 DEC=+044448.24 EQUINOX=2000.00
          # TGT_BarnardStar=OBJECT="Barnard Star" RA=175748.50 DEC=+044136.21 EQUINOX=2000.00
```
Adjusted coordinates are defined with $PMTGT_... and the original ones ($TGT_...) are commented out.
Finding chart uses original coordinate as its center.
Database query with SIMBAD/GAIA etc. shows objects' proper motion with green dot and lines on finding chart. The green dot (●) shows the adjusted coordinate of the object in observation date. If the green dot is out of bound, please re-size and re-download your chart image.

Finding chart for Barnard star

Non-Sidereal tracking

If you want to add non-sidereal target (planets, asteroids, comets...) to the main target list, please merge their tracking file (TSC or JPL HORIZONS style).
In actual Subaru's observation, we need TSC style tracking files. Please convert JPL HORIZONS files to TSC ones by Menu→File→Non-sidereal→Convert JPL to TSC.
The time rage of files will be displayed in Note column of Main Target TAB. If the designated observation date is out of the range, its coordinate will be displayed with red. If it is within, it will be blue.
The current Subaru telescope cannot use non-sidereal tracking with auto-guiding.
Therefore, when you want to guide a non-sidereal objects on the slit (SV-guide), please follow this way.
  Do target acquisition (SetupField) with its tracking file.
  → Start SV guiding with a target on the slit.
  → Telescope mode will automatically change from non-sidereal to sidereal at this moment.
  → SV guide will adjust the difference between non-sidereal and sidereal at each moment during exposures.
If the non-sidereal motion exceeds a few arcsec/min, the correction by SV will be getting difficult. In such case, you should use Guide=NO in SetupField (Non-sidereal tracking and manual correction during exposures).
You can check the orbit of non-sidereal objects in Finding chart.
Please do not forget to send your TSC files to SA with .hoe files.

How to compile from source code (UNIX)

Required libraries to build hoe are
developper's packages for gtk+2 (ver2.24 or later), libxml2, openssl, libssh2, json-c. For example,

Developper's Package names of	in Ubuntu 18.04LTS	in CentOS 7
glib2	libglib2.0-dev	glib2-devel
openssl	libssl-dev	openssl-devel
gtk+2	libgtk+2.0-dev	gtk2-devel
libxml2	libxml2-dev	libxml2-devel
libssh2	libssh2-1-dev	libssh2-devel
json-c	libjson-c-dev	json-c-devel

The names of these packages depend on the distribution which you are using.

get the source code
1. download .tar.gz and extract it, and change directory.
2. If you download the source code via git
```
  % git clone https://github.com/chimari/hoe.git
```
  Then,
```
  % cd hoe
  % touch configure configure.ac aclocal.m4 Makefile.am Makefile.in
```
  This is necessary to avoid errors on aclocal.
```
./configure
```
If you find some errors concerning aclocal etc. stop the configure script, please use ./autogen.sh instead of ./configure .
```
make
```
```
sudo make install
```
Only an executable binary, "hoe", is required to run the program.

Akito Tajitsu updated on Wed Apr 3 18:49:27 JST 2024