How to use it: - miguelgonzalez12/Remora-wiki-draft- GitHub Wiki
Step 1: Add TriHyb Remora to Triton
Learn how to download or clone the Triton repository with the TriHyb Remora repository in the quick setup section and how to add the Remora to Triton.
Step 2: Open up Remora on Triton
In the Control Window, use Remoras pull-down menu, hover over TriHyb, and select Compute HMD Products.
After opening, you will be shown a pop up that contains information on the HARP which is all on the tab Metadata Compiler.
With the Metadata Compiler, the user is able to input information on the HARPS they are looking at; the picture above gives an example of what some info should look like. The user can either manually type in information on their HARP or click on the Import from .csv file, which will grab information from any .csv file and import it into the corresponding section. It’s important that the headers on the file directly match the ones on the Remora so that it can distribute the information correctly.
The picture above shows what a correctly formatted csv. file should look like. I will give some background on what each of the heading means.
- Title: Title of the dataset with resolution and site.
- Summary: Summary of what dataset contains.
- History: Who created the product.
- Source: How data was conducted.
- Acknowledgment:
- Citation:
- Conventions:
- Creator Role: Roles of the creators
- ID:
- Institution: Institution where data comes from.
- Keywords:
- License:
- Product Version: Version of the product
- References:
- Comment:
- Creator Name: Name of creator
- Creator URL: Creator of project URL link
- Publisher URL: URL link to publisher
- Instrument: Name of the instrument
- Keywords Vocabulary:
- Naming Authority:
- Publisher Name: Name of Publisher
If you look next to the Metadata Compiler you will see another tab, Compute HMD. This is where you can input which data you are using as well as where your data output goes.
This is what the Compute HMD section looks like on the Remora. Just like the Metadata compiler I will give some background on what each heading means.
-
Input Directory: The input directory is where you pick a file to pull data from. You can either pull data from a full deployment or examine individual time frames of data. Each deployment file has multiple “disks” that contain data from different timeframes. For example, if I wanted to look at a time frame from October to November 2023, I would pick CINMS_B_49_disk01 because it has data from September 27, 2023, until November 13, 2023. However, if you want to look at a full deployment of data, you can check the Search Subfolders box on the top right. This will have the program gather all the data from the deployment rather than just one disk.
-
Filename Pattern:
-
Output Directory: The output directory is where you can choose where you want to store the data computed through the Remora. You can make a new folder on your files and have the data stored there.
-
Transfer Function File: Transfer function calibration file with .tf file extension
-
Organization: Organization that collected and processed the data
-
Project: Project name of dataset
-
Site Name: Site name of dataset
-
Site Location: Coordinates of the site in decimal degrees
-
Deployment #: Deployment number
-
Deployment Start/End Date: Deployment start and end data in YYMMDD format
-
Start/End Frequency: Range of frequencies you want to look at
-
Minimum Effort for Minute Bin(%):
Step 3: Computing HMD
Once the user is finished correctly filling in the information on TriHyb, the final step is to compute the data.
Once you click the Compute HMD button at the bottom of the page, the program will start to run. The data being computed is transferred into the folder selected from the output directory.