Ask Your Question
2

Current best practice for creating new BCL Measure Repo?

Hi all,

Is there updated info on best practice when creating a new measure repo to connect to the BCL?

I'd like to organize some measures I've been developing into a repo that is accessible via the BCL. The documentation that the BCL Contribute Data page points to appears to be outdated. It suggests following the instructions for creating a new extension gem, however there are a few open issues suggesting the rake task bundle exec rake init_new_gem is outdated.

With that in mind, I can't find any current guidance for an up to date way to build out the required folders for a measure gem. Is there a repo I can fork and modify to build a fresh measure repo? It's not clear to me if the creating a new extension gem is even necessary for a BCL measure repo, so if I'm overcomplicating this, I'd appreciate it if someone could let me know.

Thanks y'all.

GFlechas's avatar
247
GFlechas
asked 2024-07-24 16:01:23 -0500
edit flag offensive 0 remove flag close merge delete

Comments

add a comment see more comments

1 Answer

1

I sent a few emails, and it sounds like you can format your GitHub repository like a measure-gem manually and that is sufficient for having a repository that can be added to the BCL. Here's an example of what that layout would look like for a general repository of measures if anyone else has a similar question:

openstudio-measure-repo/  
├── README.md  
├── LICENSE  
└── lib/  
    └── measures/  
        ├── measure1/  
        │   ├── measure.rb  
        │   ├── measure.xml  
        │   ├── resources/  
        │   │   └── helper.rb  
        │   └── test/  
        │       └── measure1_test.rb  
        └── measure2/  
            ├── measure.rb  
            ├── measure.xml  
            ├── resources/  
            │   └── helper.rb  
            └── test/  
                └── measure2_test.rb
GFlechas's avatar
247
GFlechas
answered 2024-08-07 09:09:35 -0500
edit flag offensive 0 remove flag delete link
more

Comments

add a comment see more comments