GUIDELINES FOR BUILDING JSIM MODEL SOURCE CODE AND PROJECT FILE

Image Tab: Optional image

Notes Tab: Description of purposes and explanations for the parameter files and the plot pages.
 
Sample Source Page, limit with to 10 tabs:
|<----------------------------10 TABS---------------------------->|


// MODEL NAME: descriptive.short.name  (No spaces in name) 
// SHORT DESCRIPTION: 
// One or two lines maximum with the main points
// (The detailed description is below.)

import nsrunit; unit conversion on;

math -Name- { realDomain t sec ; t.min = 0; t.max = ; t.delta = ;

// PARAMETERS:
real
 param1 =  		units,		// Comments
 param2 = 		units,		// Comments
 param3 = 		units;		// Comments

// VARIABLES:
extern real var0(t);	                // External driving function
real
 var1(t)		units,		// Comments
 var2(t)		units,		// Comments
 var3(t)		units;		// Comments

// INITIAL CONDITIONS:
when (t=t.min) { -Try to minimize the number of lines- }

// ODE or PDE or ALGEBRAIC EQUATIONS:
 eq1 = ...		     ;		// Comments
 eq2 = ...		     ;		// Comments
 eq3 = ...	    	     ;		// Comments
 var1:t = 	   	     ; 		// Comments
}

/*
 FIGURE:
          -------/\/\/\/\----o----/\/\/\/\-----CCCCC---o

 LEGEND:
		CCCCC = Inductance

 DETAILED DESCRIPTION:
 	- Concise
	- Nature and purpose of the model
	- Refer to code sections where possible

 SHORTCOMINGS/GENERAL COMMENTS:
	- Specific inadequacies or next level steps
 
 KEY WORDS: About 10 words or phrases relating to the model and the context for it.
            Comma separate each one.  

 REFERENCES:
	- Refer to original article or any relevant article (one blank line between refs).

	- Authors first followed by colon: rest of reference

        - Ex: Doe J, Doe R, Smith K.L.:"Modeling Oxygen Uptake", Journal of Heart Meds, 2:31-55, 2001

	- Web references can go here as well.

 REVISION HISTORY:
	Original Author : JBB  Date: 06/12/08
	Revised by:     Date:19apr10 : description of revision
	

 COPYRIGHT AND REQUEST FOR ACKNOWLEDGMENT OF USE:   
  Copyright (C) 1999-2018 University of Washington. From the National Simulation Resource,  
  Director J. B. Bassingthwaighte, Department of Bioengineering, University of Washington, Seattle WA 98195-5061. 
  Academic use is unrestricted. Software may be copied so long as this copyright notice is included.

  When citing JSim please use this reference: Butterworth E, Jardine BE, Raymond GM, Neal ML, Bassingthwaighte JB. 
  JSim, an open-source modeling system for data analysis [v3; ref status: indexed, http://f1000r.es/3n0] 
  F1000Research 2014, 2:288 (doi: 10.12688/f1000research.2-288.v3)  

  This software was developed with support from NIH grants HL088516 and HL073598, NIBIB grant BE08417,
  the Cardiac Energy Grid HL122199 (PI: J.B. Bassingthwaighte), and the Virtual Physiological Rat program 
  GM094503 (PI: D.A.Beard). Please cite these grants in any publication for which this software is used and 
  send an email with the citation and, if possible, a PDF file of the paper to: staff@physiome.org. 

*/
From Senthil Kabilan. sep08 Revised 19sep08, 28dec08 by J BAssingthwaighte
 Mar 09 by BEJ
 09Dec2009 by BEJ - change where to send paper that uses model.
 05Jan2010 by BEJ - change copyright year
 28Jan2010 by BEJ - change email to staff@physiome.org
 09Mar2011 by BEJ - change copyright yr and streamline revision language.
 24Jan2012 by BEJ - change copyright yr
 03Jul2013 by BEJ - change copyright yr
 25Mar2014 by BEJ - add grant #s and change copyright yr
 23Sep2014 by BEJ - add JSim citation
 12jan2016 by BEJ - update copyright and grants.