pyref_core/lib.rs
1/// Reads a FITS file and converts it to a Polars DataFrame.
2///
3/// # Arguments
4/// * `file_path` - Path to the FITS file to read
5/// * `header_items` - List of header values to extract
6///
7/// # Returns
8///
9/// A `Result` containing either the DataFrame or a `FitsLoaderError`.
10///
11/// # Example
12///
13/// ```
14/// use pyref_ccd::{read_fits, loader::ExperimentType};
15/// use std::path::Path;
16///
17/// // Using experiment type
18/// let df = read_fits("path/to/file.fits", ExperimentType::Xrr);
19///
20/// // Using raw header keys
21/// let df = read_fits("path/to/file.fits", &["LAMBDA", "THETA", "DATA"]);
22/// ```
23/// Documentation for read_multiple_fits, read_experiment, and read_experiment_pattern
24/// functions is available in the loader module where they are defined.
25pub mod errors;
26pub mod io;
27pub mod loader;
28pub mod documentation {
29 // No code changes needed here
30}
31
32// Re-export key types and functions for easier access
33pub use errors::FitsLoaderError;
34pub use loader::{read_experiment, read_experiment_pattern, read_fits, read_multiple_fits};