Release: v0.1.0

[RemingtonRohel]

Installation

pip install git+https://github.com/SuperDARNCanada/procDARN.git@develop

Python API

In-memory fitting

Use FITACF3 algorithm to fit a list of RAWACF records

fitacf3(recs: list[dict]) -> list[dict]

Example

import procdarn
import dmap
infile = "path/to/rawacf"
rawacf_records = dmap.read_rawacf(infile)
fitacf_records = procdarn.fitacf3(rawacf_records)
dmap.write_fitacf(fitacf_records, "path/to/fitacf")

File-to-file fitting

Fit a RAWACF file into a FITACF file

file_fitacf3(rawacf_file: str, fitacf_file: str)

Example

import procdarn
procdarn.file_fitacf3("path/to/rawacf", "path/to/fitacf")

Rust API

• procdarn::file_fitacf3(raw_file: PathBuf, fit_file: PathBuf) -> Result<(), Fitacf3Error>: Fits a RAWACF file into a FITACF file
• procdarn::fitting::fitacf3::fitacf_v3::fitacf3(Vec<RawacfRecord>) -> Result<Vec<FitacfRecord>, Fitacf3Error>: single-threaded FITACFv3 on collection of RawacfRecords (from dmap crate)
• procdarn::fitting::fitacf3::fitacf_v3::par_fitacf3(Vec<RawacfRecord>) -> Result<Vec<FitacfRecord>, Fitacf3Error>: multi-threaded FITACFv3 implementation

Binary

fit_fitacf3: Command-line tool for fitting a rawacf file

Usage: fit_fitacf3 <INFILE> <OUTFILE>

Arguments:
  <INFILE>   Rawacf file to fit
  <OUTFILE>  Output fitacf file path

Options:
  -h, --help     Print help
  -V, --version  Print version