speleotica/frcsdata

Parser for Chip Hopper's survey data format used in Fisher Ridge Cave System

@speleotica/frcsdata

Parser for Chip Hopper's survey data format used in Fisher Ridge Cave System

Parse function variants

AsyncIterable: parseFrcsXFile(file: string, lines: AsyncIterable<string>): Promise<FrcsXFile>

These can be imported from the package root (@speleotica/frcsdata). The other variants wrap these.

String: parseFrcsXFile(file: string, data: string): Promise<FrcsXFile>

These can be imported from @speleotica/frcsdata/string.

Node: parseFrcsXFile(file: string): Promise<FrcsXFile>

These can be imported from @speleotica/frcsdata/node and read the given file from disk. They require Node >=12.

File types

I'm not going to document this much right now but there are three types of files:

Survey Files

These files typically look like cdata.fr where the extension is actually an abbrevation of the cave name.

import { parseFrcsSurveyFile } from '@speleotica/frcsdata'
import { parseFrcsSurveyFile } from '@speleotica/frcsdata/node'
import { parseFrcsSurveyFile } from '@speleotica/frcsdata/string'

These functions return a Promise that resolves to an FrcsSurveyFile.

Trip Summary Files

These files typically look like STAT_sum.txt.

import { parseFrcsTripSummaryFile } from '@speleotica/frcsdata'
import { parseFrcsTripSummaryFile } from '@speleotica/frcsdata/node'
import { parseFrcsTripSummaryFile } from '@speleotica/frcsdata/string'

These functions return a Promise that resolves to an FrcsTripSummaryFile.

Plot Files

These files typically look like FOR008.fr where the extension is actually an abbrevation of the cave name.

import { parseFrcsPlotFile } from '@speleotica/frcsdata'
import { parseFrcsPlotFile } from '@speleotica/frcsdata/node'
import { parseFrcsPlotFile } from '@speleotica/frcsdata/string'

These functions return a Promise that resolves to an FrcsPlotFile.

frcsdata's Issues

Figure out what FT CC BB means and support it if valid

Figure out what FF CC DD means and support it if valid

Support Chip's splay format

G$30UG$22  6.58 s 302.7      -38.4                 

Support Chip's from station LRUD format

ALT18ALT13    11 * 229.9 230.6  2.0  1.93.5  7  9  2   ALT13 12 1 10 2

alignment appears to vary:

ALT28ALT24  11.6    44.2  42.9 -4.6 -3.7  1  21.53.9  ALT24 3 2 1 5

Scanned notes for trip 923 aren't getting linked for some reason