GENESIS: Documentation

Related Documentation:

Documentation Notation

GENESIS has a defined set of notations that aim to increase the readability and simplify the intended meaning of documentation for users and developers. These notations are primarily employed in the user tutorials and are defined here.

• Single Line Input: At various points in tutorial documentation you will be instructed to enter GENESIS commands through the keyboard. This will be indicated by showing the text to be entered in a monospaced “typewriter” font. For clarity this text is enclosed within quotes. Note that only the text within the quotes should be entered, not the quotes themselves.
• Single Line Output: Single lines of GENESIS output are given in the same monospaced typewriter font employed for command entry, but without surrounding quotes.
• Multi-Line Input and Output: Multiple lines of GENESIS input or output are defined by their context and presented as blocks of the monospaced typewriter font. They are typically either formated and/or indented e.g.

  create cell /neuron       create segment /neuron/soma       set_model_parameter /neuron/soma Vm_init -0.068       set_runtime_parameter /neuron/soma INJECT 2e-9       add_output /neuron/soma Vm       run /neuron 0.1       simulation_state_save /neuron       sh cat /tmp/output

• Component Names: Given in Bold Typeface and indicated by (leading) capital letters. They can usually be distinguished by their context in text and should not be confused with headings, which are also in bold typeface.
• Function, Object and Structure Names: These should be indicated in the text in the following way:
  • Function names: PulseGenCalloc()
  • Object names: PulseGenCalloc{}
  • Structure names: PulseGenCalloc{}
• Text Replacement: Text included within <angle brackets> should be replaced with a specific user-supplied name or string.
• File/Function/Script Names and Directory Paths: These are indicated in italics.
• Missing Text: Missing text is indicated with an ellipses (. . . ).