Read a local BADM (BIF) file
amf_read_bifRead local BADM Interchange Format (BIF) files from BASE-BADM or FLUXNET downloads to extract site metadata groups, UTC offsets, DOI/citation records, and funding acknowledgments.
Instructions
Read a local BADM Interchange Format file, the site metadata shipped in BASE-BADM (xlsx) and AmeriFlux FLUXNET (CSV) downloads, also from inside the zip: entries by group (location, IGBP, team, instruments, disturbance …), UTC offsets with their start dates, the DOI and citation recorded for that version, and funding acknowledgments. Emails and addresses are withheld by default. stdio only. Next: call amf_get_citation for the current citation.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| file | No | A BIF xlsx or CSV, or an archive holding one (BASE-BADM, FLUXNET), relative to a local root. Or give site. | |
| site | No | The newest local BIF of this site. | |
| limit | No | ||
| groups | No | Only these groups, e.g. ['GRP_UTC_OFFSET', 'GRP_DOI']. | |
| offset | No | ||
| site_id | No | In a bulk file (AA-Flx, AA-Net): only this site. | |
| include_contacts | No | Emails and addresses, if the server allows it (privacy settings). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | Yes | ||
| notes | No | ||
| source | No | ||
| entries | Yes | ||
| fileInfo | Yes | ||
| resolved | No | ||
| withheld | Yes | ||
| citations | Yes | ||
| nextSteps | No | ||
| utcOffsets | Yes | ||
| acknowledgments | Yes |