All proposed major improvements to the science or software in APSIM (either to existing or new modules) will be evaluated by the Reference Panel (RP) in terms of science and software quality.
The following is a summary of the key steps and documentation required to have any improvements or modifications to the science or software evaluated, approved and incorporated into APSIM:
Step 1: Proposal:
A developer submits a proposal to the RP to undertake a major improvement. This is submitted through the Major Tasks
If the task is not a major improvement, then minor bug reports can be submitted through the Bugs & Tasks
Step 2: Proposal Evaluation:
The Reference Panel (RP) reviews the proposal and makes a decision as to whether there is enough information and justification to proceed. A RP member will be appointed as a key contact and may assist the developer as required.
Step 3: Implementation:
If the RP gives approval to proceed, it will request the developer to undertake implementation of the proposal. This involves development of the modifications or improvements (i.e. model changes and software code) plus provision of all supporting documentation (i.e. science documentation, validation data sets and other relevant information).
Step 4: Review:
A formal review of the implementation is undertaken and a report prepared with recommendations for the RP to consider. The RP then makes a decision as to whether the improvements should be incorporated into APSIM.
Step 5: Release:
If approved by the RP, The Software Engineering Group incorporates the modifications through its Version Control Process.
Process Flow Chart
Instructions to Developers and Reviewers