APSIMInitiative / APSIM710

APSIM
https://www.apsim.info
30 stars 47 forks source link

Port PLANT to C# #1025

Closed ApsimBot closed 5 years ago

ApsimBot commented 5 years ago

Legacy Bug ID: 1571 Author: Dean Date: 2012-07-30 14:09:50 +0000 UTC

STEP 1: PROPOSAL Short description of the concept or proposed improvements (describe the problem): We (the SEG) propose to port the aging PLANT model to C#.

Rationale and Justification (why is this problem important):
We wish to do this because:

1. PLANT is difficult to maintain,

2. C# is our preferred language and C# models run easily in ApsimX (the next generation of APSIM). 

3. The existing major tasks to move various models to C# are taking too long to complete as they are not just software ports of code but rather new model creations that will require calibration and re-validation.

Details of the proposed improvements (how you want to fix it):
We propose to perform a software port of PLANT to C#, reusing as much of Plant2 source code as possible . In addition we will:

1. Perform some refactoring of source code for enhanced readibility.

2. Create a conversion tool to convert PLANT XML files to the new PLANT2 XML style.

3. Create a .apsim / .con conversion tool to map old style variable name to Plant2 style variable names.

4. Create a series of test suites that exercise each plant crop model for: N and P uptake, SWIM comms, Canopy (Micromet) comms, Grazing comms.

5. Enhance the PLANT model documentation, possible through the use of auto-generated documentation techniqutes.

Implications for users (how will this particular fix help):
Model output variable names will change - these will be automatically converted for the user. Simulation results will change only slightly (4th or 5th sig. fig.)

Reviewer:

Review Panel Contact:

Supporting documentation (optional):
ApsimBot commented 5 years ago

Author: murphy Date: 2012-08-30 14:23:00 +0000 UTC

The Rerence Panel evaluated this task and agreed to proceed to Implementation. This is unlikely to happen until afer the next release (I.e. after APSIM V7.5). Prior to final implementation, review and release a news item will be prepared to advise users and seek feedback.