Adding new programs to Madagascar - Revision history

Fomels: typos

2024-11-25T02:28:59Z

typos

Sfomel: /* Style guide */

2015-06-16T23:16:18Z

Style guide

← Older revision		Revision as of 23:16, 16 June 2015
Line 107:		Line 107:
	* User interface convention: if your program provides a verbosity option, use <tt>verb=n [y/n]</tt>		* User interface convention: if your program provides a verbosity option, use <tt>verb=n [y/n]</tt>
	* Do not keep commented code in your program. This does not refer to writing comments about code, but to commenting out actual code. You can always use the version control system to retrieve the older version		* Do not keep commented code in your program. This does not refer to writing comments about code, but to commenting out actual code. You can always use the version control system to retrieve the older version
	* Use standard C: declare all variables in the beginning of the program, use C-style comments <~~syntaxhighlight lang="c"~~>/* */</~~syntaxhighlight~~>. Some compilers do not allow C++ style variable declarations and comments in C programs.		* Use standard C: declare all variables in the beginning of the program, use C-style comments <tt>/* */</tt>. Some compilers do not allow C++ style variable declarations and comments in C programs.

	==How to test your program==		==How to test your program==

Sfomel: /* Style guide */

2015-06-16T23:15:39Z

Style guide

← Older revision		Revision as of 23:15, 16 June 2015
Line 107:		Line 107:
	* User interface convention: if your program provides a verbosity option, use <tt>verb=n [y/n]</tt>		* User interface convention: if your program provides a verbosity option, use <tt>verb=n [y/n]</tt>
	* Do not keep commented code in your program. This does not refer to writing comments about code, but to commenting out actual code. You can always use the version control system to retrieve the older version		* Do not keep commented code in your program. This does not refer to writing comments about code, but to commenting out actual code. You can always use the version control system to retrieve the older version
	* Use standard C: declare all variables in the beginning of the program, use C-style comments /* */. Some compilers do not allow C++ style variable declarations and comments in C programs.		* Use standard C: declare all variables in the beginning of the program, use C-style comments <syntaxhighlight lang="c">/* */</syntaxhighlight>. Some compilers do not allow C++ style variable declarations and comments in C programs.

	==How to test your program==		==How to test your program==

Sfomel: /* Style guide */

2015-06-16T23:14:51Z

Style guide

← Older revision		Revision as of 23:14, 16 June 2015
Line 107:		Line 107:
	* User interface convention: if your program provides a verbosity option, use <tt>verb=n [y/n]</tt>		* User interface convention: if your program provides a verbosity option, use <tt>verb=n [y/n]</tt>
	* Do not keep commented code in your program. This does not refer to writing comments about code, but to commenting out actual code. You can always use the version control system to retrieve the older version		* Do not keep commented code in your program. This does not refer to writing comments about code, but to commenting out actual code. You can always use the version control system to retrieve the older version
	* ~~Initialize~~ all ~~pointers (including~~ variables of ~~type <tt>sf_file<~~/~~tt>) with NULL~~		* Use standard C: declare all variables in the beginning of the program, use C-style comments /* */. Some compilers do not allow C++ style variable declarations and comments in C programs.
	* ~~If you have one or more calls to <tt>sf_input</tt> in your program, call <tt>sf_close<~~/~~tt> before exit to avoid file leaks (temporary files left~~ in ~~$DATAPATH after an operation involving pipes)~~

	==How to test your program==		==How to test your program==

Sfomel: /* Vim customization */

2015-03-07T15:18:46Z

Vim customization

← Older revision		Revision as of 15:18, 7 March 2015
Line 167:		Line 167:

	<syntaxhighlight lang="bash">		<syntaxhighlight lang="bash">
	au BufRead,BufNewFile SConstruct ~~setfiletype~~ python		au BufRead,BufNewFile SConstruct set filetype=python

	syntax enable		syntax enable
	</syntaxhighlight>		</syntaxhighlight>

Sfomel: /* Vim customization */

2014-04-08T21:09:04Z

Vim customization

← Older revision		Revision as of 21:09, 8 April 2014
Line 166:		Line 166:
	To enable syntax highlighting on SConstruct files in vim, add the following to your <tt>~/.vimrc</tt> file:		To enable syntax highlighting on SConstruct files in vim, add the following to your <tt>~/.vimrc</tt> file:

	<bash>		<syntaxhighlight lang="bash">
	au BufRead,BufNewFile SConstruct setfiletype python		au BufRead,BufNewFile SConstruct setfiletype python

	syntax enable		syntax enable
	</~~bash~~>		</syntaxhighlight>

Sfomel: /* Emacs customization */

2014-04-08T21:08:29Z

Emacs customization

← Older revision		Revision as of 21:08, 8 April 2014
Line 141:		Line 141:

	* Install the [http://www.emacswiki.org/cgi-bin/wiki/PythonMode python mode] (if you don't have it installed already) and put		* Install the [http://www.emacswiki.org/cgi-bin/wiki/PythonMode python mode] (if you don't have it installed already) and put
	<lisp>		<syntaxhighlight lang="lisp">
	(setq auto-mode-alist		(setq auto-mode-alist
	(cons '("SConstruct" . python-mode) auto-mode-alist))		(cons '("SConstruct" . python-mode) auto-mode-alist))
	</~~lisp~~>		</syntaxhighlight>
	:in your <tt>.emacs</tt> file to enable it on <tt>SConstruct</tt> files.		:in your <tt>.emacs</tt> file to enable it on <tt>SConstruct</tt> files.

	* Put		* Put
	<lisp>		<syntaxhighlight lang="lisp">
	(set-default 'compile-command "scons")		(set-default 'compile-command "scons")
	</~~lisp~~>		</syntaxhighlight>
	:in your <tt>.emacs</tt> file to have <tt>scons</tt> as the default compile command.		:in your <tt>.emacs</tt> file to have <tt>scons</tt> as the default compile command.

	* Use		* Use
	<lisp>		<syntaxhighlight lang="lisp">
	(add-hook 'c-mode-common-hook		(add-hook 'c-mode-common-hook
	'(lambda () (c-set-style "linux")		'(lambda () (c-set-style "linux")
	(c-set-offset 'case-label 4)		(c-set-offset 'case-label 4)
	(setq c-basic-offset 4)))		(setq c-basic-offset 4)))
	</~~lisp~~>		</syntaxhighlight>
	:to make sure that the identation in C files follows the previously adopted convention.		:to make sure that the identation in C files follows the previously adopted convention.

Sfomel: /* Backups */

2014-04-08T21:07:25Z

Backups

← Older revision		Revision as of 21:07, 8 April 2014
Line 122:		Line 122:
	===Backups===		===Backups===
	You may want to back up only your developer directory, not the entire Madagascar source tree. If you do not want to or do not have the permissions to change the backup scripts, you will need to make your RSF user directory a link to somewhere else. To get that to work, you need to modify your <tt>username/SConstruct</tt>. First thing in the file, define		You may want to back up only your developer directory, not the entire Madagascar source tree. If you do not want to or do not have the permissions to change the backup scripts, you will need to make your RSF user directory a link to somewhere else. To get that to work, you need to modify your <tt>username/SConstruct</tt>. First thing in the file, define
	<python>		<syntaxhighlight lang="python">
	RSF_src_root = '/path/to/madagascar/source/root/'		RSF_src_root = '/path/to/madagascar/source/root/'
	</~~python~~>		</syntaxhighlight>
	Then, replace <tt>../..</tt> throughout the SConstruct with		Then, replace <tt>../..</tt> throughout the SConstruct with
	<python>		<syntaxhighlight lang="python">
	os.path.join(RSF_src_root,'whatever_followed_after_dotdots')		os.path.join(RSF_src_root,'whatever_followed_after_dotdots')
	</~~python~~> .		</syntaxhighlight>

	===External libraries===		===External libraries===

Sfomel: /* Self-doc for Python programs */

2014-04-08T21:04:24Z

Self-doc for Python programs

← Older revision		Revision as of 21:04, 8 April 2014
Line 46:		Line 46:
	====Self-doc for Python programs====		====Self-doc for Python programs====
	To automatically populate the <tt>Description</tt> page, and <tt>Comments</tt> sections, use the following syntax. Start the file with:		To automatically populate the <tt>Description</tt> page, and <tt>Comments</tt> sections, use the following syntax. Start the file with:
	<python>		<syntaxhighlight lang="python">
	#! /usr/bin/env python		#! /usr/bin/env python
	'''My one-line description of this program		'''My one-line description of this program
Line 54:		Line 54:

	# Copyright notice...		# Copyright notice...
	</~~python~~>		</syntaxhighlight>
	Then, make sure to		Then, make sure to
	<python>		<syntaxhighlight lang="python">
	import rsfprog		import rsfprog
	</~~python~~>		</syntaxhighlight>
	To make input parameters and their default values (if they exist) automatically appear in the <tt>Synopsis</tt> and <tt>Parameters</tt> sections, make sure to follow each argument read with a comment, and call <tt>selfdoc</tt> if no argument was given. Here is an example from <tt>user/ivlad/Mpclip.py</tt>:		To make input parameters and their default values (if they exist) automatically appear in the <tt>Synopsis</tt> and <tt>Parameters</tt> sections, make sure to follow each argument read with a comment, and call <tt>selfdoc</tt> if no argument was given. Here is an example from <tt>user/ivlad/Mpclip.py</tt>:
	<python>		<syntaxhighlight lang="python">
	par = rsf.Par(argv)		par = rsf.Par(argv)

Line 70:		Line 70:

	verb = par.bool('verb', False) # if y, print system commands, outputs		verb = par.bool('verb', False) # if y, print system commands, outputs
	</~~python~~>		</syntaxhighlight>

	====Self-doc for Fortran 90 programs====		====Self-doc for Fortran 90 programs====

Sfomel: /* Self-doc for C programs */

2014-04-08T21:03:24Z

Self-doc for C programs

← Older revision		Revision as of 21:03, 8 April 2014
Line 23:		Line 23:
	====Self-doc for C programs====		====Self-doc for C programs====
	To automatically populate the <tt>Description</tt> and <tt>Comments</tt> sections, use the following syntax. Start the file with:		To automatically populate the <tt>Description</tt> and <tt>Comments</tt> sections, use the following syntax. Start the file with:
	<c>		<syntaxhighlight lang="c">
	/* Short description line		/* Short description line
	Comments here blablabla lorem ipsum dolores sit amet...		Comments here blablabla lorem ipsum dolores sit amet...
Line 30:		Line 30:

	/* Copyright notice */		/* Copyright notice */
	</c>		</syntaxhighlight>
	Notice that: (1) the description line is the first line in the file; (2) Comments are closed and then open again on a new line for Copyright (so that Copyright does not show up in the documentation).		Notice that: (1) the description line is the first line in the file; (2) Comments are closed and then open again on a new line for Copyright (so that Copyright does not show up in the documentation).

	To make input parameters and their default values (if they exist) automatically appear in the <tt>Synopsis</tt> and <tt>Parameters</tt> sections, make sure to read the parameters in the code like in the following example:		To make input parameters and their default values (if they exist) automatically appear in the <tt>Synopsis</tt> and <tt>Parameters</tt> sections, make sure to read the parameters in the code like in the following example:
	<c>		<syntaxhighlight lang="c">
	if (!sf_getbool("su",&su)) su=false;		if (!sf_getbool("su",&su)) su=false;
	/* y if input is SU, n if input is SEGY */		/* y if input is SU, n if input is SEGY */
	</c>		</syntaxhighlight>
	Notice that there are no complex logical operations inside the <tt>if</tt>, that there is no space between the equal sign and the right and left hand, and that a short comment follows immediately. If by necessity the parameter is read in a complex fashion, use angular brackets inside the short line following the read block, i.e.:		Notice that there are no complex logical operations inside the <tt>if</tt>, that there is no space between the equal sign and the right and left hand, and that a short comment follows immediately. If by necessity the parameter is read in a complex fashion, use angular brackets inside the short line following the read block, i.e.:
	<pre>		<pre>