dfo.nafc
DFO NARC data format parser.
The Fisheries and Oceans Canada - Newfoundland and Labrador Region - North Atlantic Fisheries Centre (NAFC) is a research facility located in St. John's, Newfoundland and Labrador.
pcnv(path, rename_variables=True, generate_extra_variables=True, global_attributes=None, encoding='UTF-8', encoding_errors='strict', match_metqa_table=False)
¶
DFO NAFC pcnv file format parser.
The pcnv format essentially a seabird cnv file format with NAFC specific inputs within the manual section.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path |
Path
|
pcvn file path |
required |
rename_variables |
bool
|
Rename variables to DFO BODC names. Defaults to True. |
True
|
generate_extra_variables |
bool
|
Generate extra vocabulary variables. Defaults to True. |
True
|
global_attributes |
dict
|
Global attributes to add to the dataset. |
None
|
encoding |
str
|
File encoding. Defaults to "UTF-8". |
'UTF-8'
|
encoding_errors |
str
|
Encoding errors handling. |
'strict'
|
match_metqa_table |
bool
|
Match metqa table to the file if available within same directory. Defaults to True. |
False
|
Returns:
Type | Description |
---|---|
Dataset
|
xr.Dataset |
Source code in ocean_data_parser/parsers/dfo/nafc.py
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 |
|
pfile(file, encoding='UTF-8', rename_variables=True, generate_extra_variables=True, encoding_errors='strict')
¶
Parse DFO NAFC oceanography p-file format.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
file |
str
|
file path |
required |
encoding |
str
|
file encoding. Defaults to "UTF-8". |
'UTF-8'
|
rename_variables |
bool
|
Rename variables to BODC standard. Defaults to True. |
True
|
generate_extra_variables |
bool
|
Generate extra BODC mapping variables. Defaults to True. |
True
|
encoding_errors |
str
|
Encoding errors handling. |
'strict'
|
Raises:
Type | Description |
---|---|
TypeError
|
File provided isn't a p file. |
Returns:
Type | Description |
---|---|
Dataset
|
xr.Dataset: Parser dataset |
Source code in ocean_data_parser/parsers/dfo/nafc.py
365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 |
|
p-files vocabulary¶
legacy_p_code | accepted_instruments | apply_func | seabird_name | variable_name | long_name | units | sdn_uom_urn | sdn_uom_name | instrument | comments | sdn_parameter_urn | sdn_parameter_name | bodc_alternative_label | definition | standard_name | coverage_content_type |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
cond | c0S/m | CNDCST01 | Conductivity | S/m | SDN:P06::UECA | Siemens per metre | 1st sensor | SDN:P01::CNDCST01 | Electrical conductivity of the water body by CTD | CTDCond | sea_water_electrical_conductivity | physicalMeasurement | ||||
cond2 | c1S/m | CNDCST02 | Conductivity, 2 | S/m | SDN:P06::UECA | Siemens per metre | 2nd sensor | SDN:P01::CNDCST02 | Electrical conductivity of the water body by CTD (sensor 2) | CTDCond2 | sea_water_electrical_conductivity | physicalMeasurement | ||||
flor | CPHLPR01 | Fluorescence | mg/m^3 | SDN:P06::UMMC | Milligrams per cubic metre | 1st sensor | SDN:P01::CPHLPR01 | Concentration of chlorophyll-a {chl-a CAS 479-61-8} per unit volume of the water body [particulate >unknown phase] by in-situ chlorophyll fluorometer | chl-a_water_ISfluor | In-situ fluorometer with either manufacturer, laboratory or sample calibration applied. | mass_concentration_of_chlorophyll_a_in_sea_water | physicalMeasurement | ||||
flor | WET Labs ECO-AFL/FL |
flECO-AFL | Fluorescence, Wet Labs Eco-Afl/Fl | mg/m^3 | SDN:P06::UMMC | Milligrams per cubic metre | WET Labs ECO-AFL/FL | 1st sensor | mass_concentration_of_chlorophyll_a_in_sea_water | physicalMeasurement | ||||||
flor | Chelsea Aqua 3 Chl Con |
flC | Fluorescence, Chelsea Aqua 3 Chl Con | mg/m^3 | SDN:P06::UGPL | Micrograms per litre | Chelsea Aqua 3 Chl Con | 1st sensor | mass_concentration_of_chlorophyll_a_in_sea_water | physicalMeasurement | ||||||
oxy | sbeox0ML/L | DOXYSU01 | Oxygen, SBE 43 | ml/l | SDN:P06::UMLL | Millilitres per litre | SBE 43 | 1st sensor | SDN:P01::DOXYSU01 | Concentration of oxygen {O2 CAS 7782-44-7} per unit volume of the water body [dissolved plus reactive particulate phase] by Sea-Bird SBE 43 sensor and no calibration against sample data | WC_dissO2_uncalib | Sea-Bird SBE 43 oxygen sensor with no field calibration against sample data | volume_fraction_of_oxygen_in_sea_water | physicalMeasurement | ||
oxy | sbeox0ML/L | DOXYZZ01 | Oxygen, SBE 43 | ml/l | SDN:P06::UMLL | Millilitres per litre | SBE 43 | 1st sensor | SDN:P01::DOXYZZ01 | Concentration of oxygen {O2 CAS 7782-44-7} per unit volume of the water body [dissolved plus reactive particulate phase] by in-situ sensor | WC_dissO2_IS | Unspecified type of oxygen sensor with no information on whether it has been calibrated against sample data | volume_fraction_of_oxygen_in_sea_water | physicalMeasurement | ||
oxy2 | sbeox1ML/L | DOXYSU02 | Oxygen, SBE 43, 2 | ml/l | SDN:P06::UMLL | Millilitres per litre | SBE 43 | 2nd sensor | SDN:P01::DOXYSU02 | Concentration of oxygen {O2 CAS 7782-44-7} per unit volume of the water body [dissolved plus reactive particulate phase] by Sea-Bird SBE 43 sensor (second sensor) and no calibration against sample data | WC_dissO2_uncalib2 | Secondary Sea-Bird SBE 43 oxygen sensor with no field calibration against sample data | volume_fraction_of_oxygen_in_sea_water | physicalMeasurement | ||
oxy2 | sbeox1ML/L | DOXYZZ02 | Oxygen, SBE 43, 2 | ml/l | SDN:P06::UMLL | Millilitres per litre | SBE 43 | 2nd sensor | SDN:P01::DOXYZZ02 | Concentration of oxygen {O2 CAS 7782-44-7} per unit volume of the water body [dissolved plus reactive particulate phase] by in-situ sensor | WC_dissO2_IS_2 | Unspecified type of oxygen sensor with no information on whether it has been calibrated against sample data | volume_fraction_of_oxygen_in_sea_water | physicalMeasurement | ||
oxypsat | oxsatML/L | OXYSZZ01 | Oxygen Saturation, Weiss | ml/l | SDN:P06::UMLL | Millilitres per litre | Weiss | SDN:P01::OXYSZZ01 | Saturation of oxygen {O2 CAS 7782-44-7} in the water body [dissolved plus reactive particulate phase] | O2Sat | Computed (algorithm/data source unspecified) | physicalMeasurement | ||||
sbeox0V | sbeox0V | Oxygen Raw, SBE 43 | V | SDN:P06::UVLT | Volts | SBE 43 | 1st sensor | physicalMeasurement | ||||||||
sbeox1V | sbeox1V | Oxygen Raw, SBE 43, 2 | V | SDN:P06::UVLT | Volts | SBE 43 | 2nd sensor | physicalMeasurement | ||||||||
par | light | par | DWIRRXUD | Par/Irradiance, Biospherical/Licor | µeinsteins/s/m^2 | downwelling_photon_spherical_irradiance_in_sea_water | Biospherical/Licor | Biospherical, Licor, or Chelsea sensor; 1st sensor | SDN:P01::DWIRRXUD | Downwelling vector irradiance as energy of electromagnetic radiation (PAR wavelengths) in the water body by cosine-collector radiometer | SubSurDWVectPAR | downwelling_photon_spherical_irradiance_in_sea_water | ||||
par | Biospherical/Licor |
par | DWIRRXUD | Par/Irradiance, Biospherical/Licor | µeinsteins/s/m^2 | downwelling_photon_spherical_irradiance_in_sea_water | Biospherical/Licor | Biospherical, Licor, or Chelsea sensor; 1st sensor | SDN:P01::DWIRRXUD | Downwelling vector irradiance as energy of electromagnetic radiation (PAR wavelengths) in the water body by cosine-collector radiometer | SubSurDWVectPAR | downwelling_photon_spherical_irradiance_in_sea_water | physicalMeasurement | |||
par | Biospherical/Satlantic |
par | DWIRRXUD | PAR/Logarithmic, Satlantic | µeinsteins/s/m^2 | downwelling_photon_spherical_irradiance_in_sea_water | Biospherical/Licor | Biospherical, Licor, or Chelsea sensor; 1st sensor | SDN:P01::DWIRRXUD | Downwelling vector irradiance as energy of electromagnetic radiation (PAR wavelengths) in the water body by cosine-collector radiometer | SubSurDWVectPAR | downwelling_photon_spherical_irradiance_in_sea_water | physicalMeasurement | |||
ph | ph | PHXXZZXX | pH | SDN:P06::UUPH | pH units | SDN:P01::PHXXZZXX | pH (unspecified scale) of the water body | pH | Minus the log of the hydrogen ion concentration (moles per litre) in the water column. | sea_water_ph_reported_on_total_scale | physicalMeasurement | |||||
pres | prDM | PRESPR01 | Pressure, Strain Gauge | dbar | SDN:P06::UPBL | Decibar | Digiquartz | Digiquartz pressure sensor | SDN:P01::PRESPR01 | Pressure (spatial coordinate) exerted by the water body by profiling pressure sensor and correction to read zero at sea level | Pres_Z | The force per unit area exerted by the water column on a mobile sensor located in the water column. | sea_water_pressure | physicalMeasurement | ||
pres | -gsw.z_from_p(pres,latitude) | depth | depth | Depth [salt water] | m | SDN:P06::ULAA | Metres | depth | coordinate | |||||||
depth | depth | depth | Depth [salt water] | m | SDN:P06::ULAA | Metres | depth | coordinate | ||||||||
sal | sal00 | PSALST01 | Salinity, Practical | PSU | SDN:P06::UUUU | Dimensionless | 1st sensor | SDN:P01::PSALST01 | Practical salinity of the water body by CTD and computation using UNESCO 1983 algorithm | P_sal_CTD | This is the preferred term for this definition. Alternative term PSALST02 is included to cover cases where there are two sensors of the same type contributing to the data set and referential integrity considerations prevent a usage of a single code. | sea_water_practical_salinity | physicalMeasurement | |||
sal2 | sal11 | PSALST02 | Salinity, Practical, 2 | PSU | SDN:P06::UUUU | Dimensionless | 2nd sensor | SDN:P01::PSALST02 | Practical salinity of the water body by CTD (second sensor) and computation using UNESCO 1983 algorithm | P_sal_CTD2 | This is the alternative term for this definition. Only use to cover cases where there are two sensors of the same type contributing to the data set and referential integrity considerations prevent a usage of a single code. | sea_water_practical_salinity | physicalMeasurement | |||
scan | scan | scan | Scan Count | physicalMeasurement | ||||||||||||
sig | sigma-t00 | SIGTEQST | Density | kg/m^3 | SDN:P06::UKMC | Kilograms per cubic metre | 1st sensor | SDN:P01::SIGTEQST | Sigma-T of the water body by computation from salinity and temperature using UNESCO algorithm | Sigma-T | Computed by UNESCO SVAN function using in-situ temperature | sea_water_sigma_t | physicalMeasurement | |||
sig2 | sigma-t11 | SIGTEQST2 | Density 2 [sigma-t] | kg/m^3 | SDN:P06::UKMC | Kilograms per cubic metre | 2nd sensor | SDN:P01::SIGTEQST | Sigma-T of the water body by computation from salinity and temperature using UNESCO algorithm | Sigma-T | Computed by UNESCO SVAN function using in-situ temperature | sea_water_sigma_t | physicalMeasurement | |||
temp | t090C | TEMPS901 | Temperature [ITS-90] | degrees_celsius | SDN:P06::UPAA | Degrees Celsius | 1st sensor | SDN:P01::TEMPS901 | Temperature (ITS-90) of the water body by CTD or STD | CTDTmp90 | sea_water_temperature | physicalMeasurement | ||||
temp2 | t190C | TEMPS902 | Temperature, 2 | degrees_celsius | SDN:P06::UPAA | Degrees Celsius | 2nd sensor | SDN:P01::TEMPS902 | Temperature (ITS-90) of the water body by CTD or STD (second sensor) | CTDTmp90_2 | sea_water_temperature | physicalMeasurement | ||||
tra | CStarAt0 | ATTNZS01 | Beam Attenuation, Wet Labs C-Star | 1/m | SDN:P06::UPRM | per metre | WET Labs C-Star | 1st sensor | SDN:P01::ATTNZS01 | Attenuation (red light wavelength) per unit length of the water body by WET Labs transmissometer and calibration to read zero in clear water | RedPWCorr | WET Labs transmissometer calibrated to zero in clear water | volume_beam_attenuation_coefficient_of_radiative_flux_in_sea_water | physicalMeasurement | ||
trp | trans | CStarTr0 | OPTCPS01 | Beam Transmission, Wet Labs C-Star | % | SDN:P06::UPCT | Percent | WET Labs C-Star | 1st sensor | SDN:P01::OPTCPS01 | Transmittance (red light wavelength) per unit length of the water body | TransmRedLight | ||||
wet | wetCDOM | CCOMD002 | Fluorescence, Wet Labs CDOM | mg/m^3 | SDN:P06::UMMC | Milligrams per cubic metre | WET Labs CDOM | 1st sensor | SDN:P01::CCOMD002 | Concentration of coloured dissolved organic matter {CDOM Gelbstoff} per unit volume of the water body [dissolved plus reactive particulate phase] by in-situ WET Labs FDOM ECO fluorometer | CDOM_fluor_WETLabs | Quantity or mass of the specified analyte in a unit volume of an unfiltered sample of fresh or salt water. | concentration_of_colored_dissolved_organic_matter_in_sea_water_expressed_as_equivalent_mass_fraction_of_quinine_sulfate_dihydrate | physicalMeasurement | ||
sigt | SIGTEQST | Sigma-T | kg/m^3 | SDN:P06::UKMC | Kilograms per cubic metre | SDN:P01::SIGTEQST | Sigma-T of the water body by computation from salinity and temperature using UNESCO algorithm | Sigma-T | Computed by UNESCO SVAN function using in-situ temperature | sea_water_sigma_t | physicalMeasurement | |||||
sigmat | SIGTEQST | Sigma-T | kg/m^3 | SDN:P06::UKMC | Kilograms per cubic metre | SDN:P01::SIGTEQST | Sigma-T of the water body by computation from salinity and temperature using UNESCO algorithm | Sigma-T | Computed by UNESCO SVAN function using in-situ temperature | sea_water_sigma_t | physicalMeasurement | |||||
time | time | Time | time | coordinate | ||||||||||||
latitude | latitude | Latitude | degrees_north | SDN:P06::DEGN | Degrees north | latitude | coordinate | |||||||||
longitude | longitude | Longitude | degrees_east | SDN:P06::DEGN | Degrees east | longitude | coordinate | |||||||||
index | index | index | auxiliaryInformation | |||||||||||||
flag | flag | Flag | qualityInformation |