Contribute

Contribute to JRTN

The modeling tool is completely open source. There is no “paid version.” You are welcome to do whatever you want with it subject to Apache 2.0 licensing terms. The intent is to move management of this to GitHub at some point, but the reality is that GitHub will probably not provide an awful lot of value at this stage. In leu of GitHub, feel free to propose changes directly to me. In practice that will not be too much different than a pull request for a blob. Like any other project the first step would be to become familiar with the tool; first as a user and then with the implementation. You should start by reviewing the JRTN implementation chapter in JRTN manuscript. The code itself has extensive comments.

The tool is currently released as a blob. This seems workable as it is about 500K. There is an alternative approach: the tool could be decomposed and the various elements committed individually:

  • 13 worksheets:
    • 3 Model worksheets, 1 each for 3 different sample profiles. These sheets have a small amount of code
    • 3 FactorTable worksheets, 1 each for 3 different sample profiles
    • 3 Scenarios worksheets, 1 each for 3 different sample profiles
    • State tax definition sheet
    • Tools access worksheet containing only control buttons
    • Summary sheet with change long and copyright notice
    • Controls sheet with a few global controls such as logging and heuristics controls
  • 17 Forms, all of which have code
  • 1 VBA module of about 6.6 K lines of code (including comments and whitespace)

This would require a small amount of new code to support “disintegration” into piece parts and reintegration into the whole to be manageable. The VBA module is probably best broken up along functional lines. My experience is that most changes involve 1-3 spreadsheets, 1 Form, and the VBA module file, so that would likely be a typical commit. My inclination is to wait and assess interest before undertaking this work.