NatLabRockies / NatLabRockies/COMPASS

Database reVX CSV export

Open
#47 5 comments 0 reactions 1 assignee View on GitHub

@castelao is already working on this.

Since Mar 5, 2025.

enhancement p-medium topic-rust-cli
Dominant language
Python
Stars
17
Forks
4
Avg merge
2d 7h
Merged PRs (30d)
17

Description

Database should support export to CSV in a reVX-compatible format. At minimum, the following columns should be exported (capitalization matters):

  • Feature Type: Contains labels for the type of setback that each row represents.
  • Feature Subtype: Contains labels for feature subtypes. Most often you this is blank or None.
  • Value Type: Specifies whether the value is a multiplier or static height.
  • Value: Numeric value of the setback or multiplier.
  • FIPS: Unique 5-digit code for each county (this can be an integer - no leading zeros required).

Note that reVX only supports county-level ordinances for now. See here for more info on the output columns.

Reminder on CLI guidelines:

Assuming the CLI name is compass-db (TBD; see #49), we want the export command to look like this by default:

compass-db export

This exports the most up-to-date version of the data into CSV files (one per technology) into the current directory. Additional options are:

  • Output directory (defaults to “.”)

    compass-db export -od (--output-directory) /dir/path

  • Technology (wind, solar, etc, defaults to all)

    compass-db export -t (--technology) [wind,solar]

  • File type (CSV, Geopackage, geoparquet?, Excel?; defaults to CSV)

    compass-db export -f (--format) [csv,gpkg,gpq]

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.