This is part of the labels / documentation for <a href='http://jcm.chooseclimate.org'>Java Climate Model</a><hr/>

#layoutpanel		¨oldlink		§£>panels

#layoutmenu		¨oldlink		§£>panels

#reset		¨oldJCM4		§see @reset_all_parameters, @reset_scimod_parameters

#helpmode		¨oldJCM4 addJCM5		§when this is enabled, clicking on any object in the @treeMaker opens the relevant documentation page

#languagemenu		¨oldJCM4 addJCM5		§This parameter changes the language of some JCM labels and documentation. 

Translations have not yet been written for JCM5, however 
many were written for @JCM4. Some of these old translations remain in this version, but the user should beware they may not correspond to the current model.

For more info see @documentation, @translation

#complexitymenu		¨oldJCM4 addJCM5		§£>complexity

#verysimple		¨oldJCM4		§This is to help beginners learning how to use JCM, showing just one curve and one or two key controls per plot. It is only implemented for a few panels, to show interactions between CO2 emissions, concentration, forcing, temperature and sealevel. Beware that any simplification hides important assumptions -you should not present results derived from consideration of this level alone!

#basic		¨oldJCM4		§This is for general use. All curves and controls will be shown at normal level and above, unless their code specifies otherwise.

#expert		¨oldJCM4		§This is for scientists who know the climate system quite well and want to check out some more obscure parameters and subtle effects in JCM. Results may be confusing (particularly in some combinations with other expert options) and may not yet be well explained.  It is not expected that everybody should be able to understand expert level curves and parameters,  and expert guidance should be available if they are referred to during educational or policy applications.

#experimental		¨oldJCM4		§This complexity level is for new features of JCM under development, which may not be documented and may not yet work at all. 
"Experimental" parameters may also cause errors elsewhere in the model. Results generated using "experimental" features should not be quoted!

#linkx		¨oldJCM4		§Link all timescales (x-axes), so adjusting one will affect all

#showscales		¨oldJCM4		§Show scales on graphs (applies to all except central plot) This option switches off automatically for 9 or more plots, but you can reactivate it.

#showcontrols		¨oldJCM4		§Disabling this option hides  anything with popup info, other than title and scales. These will reappear temporarily while your mouse moves over a plot.  This option is disabled automatically for 9 or more plots, but you can reactivate it.

#ipccdata		¨oldJCM4		§see @datapoints, @compareipcc

#capim		¨oldJCM4		§see @capimage

#captab		¨oldJCM4		§see @captable

#flowchart		¨oldJCM4		§£>interacmap

#blankplot		¨oldJCM4		§Old JCM4 tool
For equivalent functions in JCM5 see 
@scripts, @createvariant

#gui		¨oldJCM4		§£>jcm.gui

#scale		¨oldJCM4		§¤adju You can adjust any scale by dragging the curve with your mouse. Dragging near the origin (usually 0 for vertical axis, 2000 for time axis) shifts the whole curve. Dragging elsewhere stretches or squeezes the scale.

¤adju Move your mouse over the axis to see pop-up info about units and range

¤adju You can hide all the scales using the @showscales option (in @layoutpanel). This option is selected automatically when many plots are shown (@layoutmenu).

For some flexible plots (descendents of @regionplot), an appropriate scale range is calculated automatically. When dividing two quantities, JCM also tries to cancel powers of ten, converting to standard SI units.

 %%¤adju If this gives you a strange quantity (e.g. "micro-person per joule per year"), it probably makes more sense to invert the ratio (e.g. megajoule per person per year). %%
  ££siunits ££unitbaseline <hr>See also @howmuchgtc ££time

#datapoints		¨oldJCM4		§This superimposes circles on the graph, corresponding to external data. It is used for checking @compareipcc

#jcmpanel		¨oldJCM4		§This holds the basic structure for a panel. Jcmpanel transfers coordinates, layout and events from mainapp, and extends iob.
  It does not extend the old 'heavyweight' java.awt panel, which is not sufficiently flexible for JCM, and would not allow for menus and other popup items to cross panels. Instead, it is a lightweight component more like those of Swing. However Swing is not used, due to its lack of support in common web browsers (note @javafuture).
  See also @jcmevent, @popob, @title. ££aboutpanels

#aboutpanels		¨oldlink		§see £>panels

#mapplot		¨oldJCM4 addJCM5		§Maps in JCM are used to illustrate: <ul>
<li> @regcli 
<li> @regionsets
<li> any regional @qtset
</ul>

¤adju You can : <ul>
<li> Rotate the map by dragging it (changes @mapstartlongitude)
<li> Change the @colorscale by dragging it
<li> Change the @projection from the View Menu
<li> Change the @regionsets from the Regions menu
%%(this may change a model parameter such as @socregions)%%
<li> Change the @mapyear, in the case of a map applying to a £`qtset
<li> @Copy_image or @save_image using the popup menu (right-click)
<li> See extra info for each region, as you move the mouse across the map
</ul>

Open maps from the @jcmtree or from the @mapsmenu menu

%%¤cogs Maps from regional £`qtsets can be used to explore distributions of @socio or @socreg. This feature is new and should be considered @experimental%%

#regionplot		¨oldJCM4		§This provides general functions for viewing and combining regional data, which are inherited by the following specific plots:   <li>@distribplot (for emissions distributions)   <li>@attributeplot (for "Brazilian proposal" calculating responsibility)   <li>@costsplot (experimental!)   <li>Note also @regemitmap, and @aboutregions
  ¤adju ---- ===General features===  <li> The @varq and @perq menus allow you to divide one quantity by another, to show, for example, emissions per capita or abatement per GDP.  <li> Because there are many possible combinations, an appropriate vertical scale is chosen automatically - see @scale  <li>When quantities are not divided by any other quantity, they may be stacked (@stack option) such that the sum of the regions shows the world total. This may be combined with the @frac option  to show each region as a fraction of the world total (multiplied by 100 to give scale in %).

#graph		¨oldJCM4		§Graph contains the basic graph-plotting functions (the curves are actually plotted onto a @bufim and repainted as needed).

Each graph has a set of curves (each with a reference to an array of data in a module, a name, a colour, and a @complexitymenu level).

Graph is also the holder for all the extra-components that make up a graph   <li>@legend  <li>Axes (see @scale)  <li>draggable @control   <li>@datapoints

Graph is 'abstract', actual instances of graph are contained within specific @panels.

Currently, just line-curve and stacked curve plots are implemented. Later, other variants (e.g. scatterplots, surface plots) may be added.

 Some extra functions are added by @regionplot

#popob		¨oldlink		§structural component of old JCM4
£>infob

#legend		¨oldJCM4 addJCM5		§makes a legend for @plots, describing each @qt
 
¤adju note that you can drag the bar between the legend and the plot. If there is space, longer labels will be used. The legend should change with @complexity.

#option		¨oldJCM4		§see @param

#menu		¨oldJCM4		§£§jcmmenu

#control		¨oldJCM4		§Draggable Arrow Controls: Each arrow controls one @param of a @module, and is positioned within a @graph whose curves it affects (via the underlying @module).
  Controls are a key feature of JCM, enabling people to understand cause-effect relationships by 'playing' with the climate system  almost as if it were a mechanical toy (see @concept).

A control may be positioned according to one or both axes of the graph, if its parameter shares the same units. Otherwise, it's position is arbitrary, and the graph limits correspond to the maximum and  minimum values of the parameter. The four-pointed arrows used for @stabilisation represent a specific point on a target curve  and so control two parameters -one for the x-axis, one for the y-axis.

¤adju Normally, you adjust the value by dragging the control. The model is updated at every step, which may slow on older computers. In this case, you may find it easier to click once on the control (note that its colour becomes darker), move the mouse to the destination, and click again, the control will jump directly to the new position (if valid).

¤adju Move your mouse over the control to see its value. If @helpmode  is enabled, clicking on it will also summon relevant documentation, including a textfield in which you can enter a specific precise value.

#plotlayout		¨oldJCM4		§This arranges the position of @pan. It also handles each @plotmenu which swaps individual plots. Specific layouts are listed in @panlist. Note, you can now have as many copies as you like of each panel, each with different setup (curves, scales etc.) -see @aboutpanels.

#panlist		¨oldlink		§£>panels, @jcm.mod

#capimage		¨oldJCM4		§This tool captures and saves a snapshot image from JCM, and saves it as a '.png' image (.png is a replacement for .gif). Just press the button £`capim on a plot (to capture that plot) or in the @layoutpanel, to capture the whole model.

This tool only works if you are using Java version 1.4 or above (see @aboutjava). You must also start JCM as an application (see @startjcm) from the downloaded package (see @download), because applets in a web-browser don't have security permission to save files.

The file will be saved in a directory jcm/output, with the same name as the panel.   <li>See also @printing, @captable.
  %%(Note, this feature was added August 2002 to prepare the JCM submission for the intercomparison exercise on the Brazilian proposal)%%

#captable		¨oldJCM4		§This tool saves a datatable corresponding to the curves of a specific panel (the same table as you see in @viewdata).  The file will be saved in the directory jcm/output, with the same name as the panel.
  This tool only works if you  have started JCM as an application, not as an applet in a web-browser (see @startjcm), because applets don't have security permission to save files.
  See also @printing, @capimage.

#printing		¨oldJCM4		§Many people ask, how can I print a copy of JCM graphics or documentation?
There is not yet support for printing directly from the model (this may be added later). However there are several ways around this:

 <h4>Copy or Save images </h4>  <ul>
<li>Use  @copy_image, either of one plot or the whole model. Paste directly into another application (e.g. a word-processor or presentation tool) and  print from there. 
  <li>Use @save_image to save a png image file, either of one plot or the whole model. Open in image-processing software, and print from there.
</ul>

  <h4>Present JCM itself, using saved setups</h4>
  If you want to capture images for use within a presentation, 
  have you considered showing people the real interactive model?
Note that you can easily save several  @setup, and open them one by one.
You can also send these text files  to another user, so they can reproduce the same setup.

  <h4>Saving data from tables</h4>see @datable


  <h4>Printing documentation</h4>
  The documentation is dependent on hyperlinks, it is not intended to be read linearly. However, if you want to print it, a file is provided which concatenates all the web pages together:
  <i>Sorry, this file no longer exists, but will be recreated soon </i>

#colfont		¨oldJCM4 addJCM5		§An interface with colors and fonts, implemented by each @jcmpanel

#welcome		¨addJCM5		§£§intropara
----
To get started see: 
@howuse (read this first!)
@mainmenu
----
£§updatedoc
Please give feedback about JCM5 to Ben Matthews
-{green //ben2 AT chooseclimate.org// }-
----
£§dedicatejesper

#objective		¨addJCM5		§This parameter determines whether the model runs a bottom-up, no-policy scenario or a top-down, inverse, mitigation or optimisation scenario.

#labdoctable		¨addJCM5		§A table of all labels and documentation, to aid checking and translating. 
Open this from @EditDoc menu in a @docview, or from the @toolsmenu
Opening may be slow as many labels are loaded into memory.

¤adju You can sort the labels by any of the initial columns (keys, categories, info, order etc.), just click on the top of the column. 
¤adju Clicking on a cell will open a @docview on that page.

¤cogs This label-table has not been checked after recent restructuring, it may behave strangely.

#interacmap		¨addJCM5		§A flow-diagram of JCM @interactions
 

This shows the chain of calculations in the model, and thus the interactions (cause-effect relationships) between the model components (any @interacob). The arrows and colors change, depending upon @params, and upon which @plots are visible.

The interactions map can be used:<ul>
<li> as a pedagogical tool, to understand cause effect relationships. 
<li>  as a navigation tool like @jcmtree (but as a network rather than a heirachy)
<li> to debug interactions problems and improve calculation efficiency
</ul>
===Layout /Lines / Colors ===
¤adju The initial layout is random, the map iterates to find a  better arrangement. It does this on opening, or when you press the "start" button. The loop-go button forces the information to refresh (see @loop).  
¤cogs Lines show links from yellow (cause) to red (effect)
¤cogs Colors also apply to each @interacob : 
<table border>
<tr><td></td><td>Visible Output</td><td>Needed for Output</td><td>Not Needed</td></tr>
<tr><td>Changed</td><td> -{ff00ff **Magenta** }-</td><td>-{00ffff **Cyan** }-</td><td>-{0000ff **Blue**}-</td></tr>
<tr><td>Not Changed</td><td> -{ff0000 **Red** }-</td><td> -{00ff00**Green** }-</td><td> -{777777 **Grey** }-</td></tr>
</table>

=== Items / Focus /  Filters ===
¤adju right-clicking on an item gives a list of actions, similar to those provided by @jcmtree
¤adju the relative emphasis given to items depends on the focus - change this by right-clicking on a component. If the interactions map is opened from an item in a tree, that item will have the initial focus. 
¤adju which items/actions are visible also depends on @filters chosen in the bar at the top, and on the chosen @complexity
¤cogs A number before a module indicates the calculation order, a number after indicates the last loop calculation time in milliseconds (only if @loopinfo is enabled).

===Drag / Zoom===
¤adju You can drag items in the flowchart to make a better arrangement
¤adju You can drag the whole map, if the mouse is not above any item.
¤adju You can zoom in/out using a mouse-wheel

££interacex

#treemaker		¨addJCM5		§£§jcmTree

#filterenabled		¨oldlink		§£>neededparams

#docview		¨addJCM5		§The documentation viewer is  like an internal web browser built into JCM.
This system enables the documentation to change according to the model setup.

¤adju Use hyperlinks to navigate between pages.
Note also the bar of shortcut icons at the top, which includes a 'back' button (left).

¤adju Since there are very many pages, you may find it easier to use the @jcmtree, together with a @filter, to quickly open relevant documentation for a specific @module, @qtset or @param. The @docmenu menu provides a similar function.

¤adju You can search for any text using the search box at the right (beware this may be slow). 
¤adju If you know the @labelcode, you can type one directly into the key box. 

¤adju You can open one more than one viewer in parallel (see @panels), to keep track of several topics or compare languages. 
The @language is specific to one viewer, but the @complexity is the same for all.

¤adju You can edit the documentation (and also labels used in the model interface) using  a wiki-style system built into JCM.  Start by choosing "Edit Doc Source" from the @EditDoc menu
.  which also has documentation about the wiki system.

#about&tools		¨addJCM5		§£>ToolsMenu

#sysout		¨addJCM5		§This shows text messages about the model progress
 (from either System.out or System.err streams)

It can be useful for debugging, or for custom calculations

See also @loopinfo

See also old labels @debug @notepad

#about&view		¨addJCM5		§£>ViewMenu

#lookandfeelmenu		¨addJCMHELLO		§This menu lets you change the "Look and Feel" (L&F) of JCM5
 graphical user interface. The list of available L&Fs includes a 'native' look and feel depending on your computer system (windows, mac, unix etc.), some standard "java" L&F  (ocean, metal), and any additional L&Fs you have installed by downloading  JAR packages from other sources. 

For extra L&Fs to be included, their jar packages must be accessible from your java classpath. You must also amend the file **lookandfeel.info** in the JCM folder **setup** // (which should also contain "current.txt" and other @setup files)//.
For each L&F add one line in this file: 
<pre>L&F name, jar.package.name.mainClassName</pre>
//For example://
<pre>Substance, org.jvnet.substance.SubstanceLookAndFeel
Napkin, net.sourceforge.napkinlaf.NapkinLookAndFeel
Walnut, my.client.plnf.wp.wood.WoodLookAndFeel
GTK, com.sun.java.swing.plaf.gtk.GTKLookAndFeel
</pre>

¤cogs Note: JCM should work OK with your default system L&F, or one of the standard java L&Fs. More exotic imported L&F packages may cause some minor display problems

see also  @SubstanceThemes,  @jcm.gui

#loopinfo		¨addJCM5		§This parameter adds extra detail  to System.out (See @sysout )  about timing and interactions each time the main model loop is run.
See also @loop

----

#qtset		¨addJCM5		§A set of @qt that have common @units and may be shown together in @plots or in a @datable
. 

¤adju £`qtsets are accessed from the @jcmtree or @menus

¤adju Maps may also be derived from any regional £`qtset, this is still experimental 

¤adju You can use the @createvariant popup menu (from @jcmtree or by right-clicking on @plots) to make a derived £`qtset  (@integral, @percent&change&per&year, @percent&of&total ) or to combine them  (@ratio:, @difference:)

¤cogs £`qtsets also have @interactions, to determine when they need to be recalculated after @params have changed

#interactions		¨addJCM5		§Managing changing interactions (calculation dependencies) between model components (@module, @param, @qtset) is essential to the efficiency of JCM as an interactive model, enabling it to work out the minimum recalculation necessary, and in which order, depending on which components have been changed and which are needed for visible output. 

¤adju Explore the 
@interacmap to understand how the interactions change.
¤cogs For more technical information see @interacob

££interacex

#textpan		¨oldJCM4		§General jcmpanel containing a java.awt.textarea. Textpan handles the problem, that textarea is a 'heavyweight' component, which doesn't mix easily with 'lightweight' components like @jcmpanel and @popob.

#jcmta		¨oldJCM4		§See @textpan

#title		¨oldJCM4		§Plot title. This also adds units and extra curve info to the basic name. Title is also used for modules in the @flowchart

#jcmevent		¨oldJCM4		§This transfers mouse events from the underlying Applet panel to a @jcmpanel or a @popob.

#bufim		¨oldJCM4		§An image buffer used by each @jcmpanel, so the main plot can quickly be repainted after moving/removing a @popob or its pop-up info, without recalculating all the curves.