Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add resource tool #276

Merged
merged 31 commits into from
Jan 23, 2025
Merged

Conversation

dchassin
Copy link
Member

@dchassin dchassin commented Jan 15, 2025

Documentation

Synopsis

gridlabd resource [OPTIONS ...]

Options

  • --content=RESOURCE,INDEX: download RESOURCE located at INDEX

  • --debug: enable traceback on exceptions

  • -h|--help|help: get this help

  • --format=[raw|csv|json]: output format

  • --index=RESOURCE: get index for RESOURCE

  • --list[=FORMAT[,OPTIONS[,...]]: list the available resources

  • --quiet: suppress error output

  • --properties=RESOURCE: get a list of resource properties

  • --silent: suppress all output exception results

  • --verbose: enable verbose output

  • --warning: disable warning output

Description

The online resource accessor delivers online resources to GridLAB-D applications.

Valid formats include json and csv (the default is 'raw').

Examples

The following command list the properties on the online weather resources

gridlabd resource --properties=weather

The following command lists the online weather resource index

gridlabd resource --index=weather

The following command retrieves the online weather data for the specified location

gridlabd resource --content=weather,WA-Seattle_Seattletacoma_Intl_A.tmy3

Managed resources

  • localhost
  • buildings
  • code
  • elevation
  • examples
  • geodata
  • icons
  • library
  • models
  • tariff
  • template
  • version
  • weather

Unmanaged resources

  • benchmarks (repo)
  • code-dev (s3)
  • converters (repo)
  • develop.code (s3)
  • develop.source (s3)
  • dmg (s3)
  • docker (s3)
  • docs-dev (s3)
  • docs (s3)
  • geodata-dev (s3)
  • gridchat (s3)
  • gridlabd (s3)
  • help (s3)
  • install-dev (s3)
  • issues (s3)
  • master.code (s3)
  • master.source (s3)
  • news (s3)
  • openfido (s3)
  • source (s3)
  • status-dev (s3)
  • status (s3)
  • test (s3)
  • training (s3)
  • tutorials-dev (s3)
  • tutorials (s3)
  • www-dev (s3)
  • www (s3)

@dchassin dchassin mentioned this pull request Jan 15, 2025
10 tasks
Signed-off-by: David P. Chassin <david.chassin@me.com>
@dchassin dchassin changed the title Add resource accessor tool Add resource tool Jan 16, 2025
@dchassin dchassin merged commit 30318fa into arras-energy:develop Jan 23, 2025
2 checks passed
@dchassin dchassin deleted the develop-add-resources branch January 23, 2025 15:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Closed
Development

Successfully merging this pull request may close these issues.

1 participant