SLIC Bug Reports

Version 8 by Jeremy McCormick
on Oct 12, 2005 13:41.

<< Changes from 7 to 8

compared with

Current by Jeremy McCormick
on Mar 06, 2006 16:57.

Key

These lines were removed. This word was removed.

These lines were added. This word was added.

View page history

There are 25 changes. View first change.


		h1. SLIC Bug Reports

		There are many possible sources of errors when the simulator crashes or exhibits "anomalous" or incorrect behavior. Also, some types of crashes, especially those that occur during batch jobs after a lot of events have been executed, can be difficult to produce.
		There are many possible sources of errors when the simulator crashes or exhibits "anomalous" or incorrect behavior. Also, some types of crashes, especially those that occur during batch jobs after a lot of events have been executed, can be difficult to reproduce. Therefore, it is imperative to make all bug reports as detailed as possible, including detailed platform configuration and step-by-step information on repeating the error.

		Therefore, it is imperative to make all bug reports as detailed as possible, with step-by-step information on repeating the error.

		h2. Jira

		Simulator bugs are tracked using the [SLIC Jira\|http://jira.slac.stanford.edu/browse/SLIC].
		Simulator bugs are tracked using the [SLIC Jira\|http://jira.slac.stanford.edu/browse/SLIC].

		Use the [Create New Issue\|http://jira.slac.stanford.edu/secure/CreateIssue!default.jspa] page to add a bug report.

		This is preferable to an email, because the Jira automatically emails the SLIC project lead when a report is filed. (This saves time from having to fill this out manually based on an email.)
		This is preferable to an email, because the Jira automatically emails the project lead when a report is filed. (This will save the developers from having to fill out the bug report manually based on an email.)

		h2. Information for the Bug Report

		At a minimum, a good bug report should have the following information.

		h3. SLIC Version

		The version is very important, because bugs (sometimes) get fixed in newer versions.
		The version is very important, because bugs can get fixed in newer versions.

		This is a string stored in the file $SLIC_BASE/VERSION.

		Simply print the contents of this file.

		{noformat}
		cat VERSION
		{noformat}

		And paste it into your bug report.

		h3. Operating System.
		It is also printed when slic starts up.

		On a Unix system, execute this command.
		h3. Operating System.

		On a Unix system, execute this command.
		{noformat}
		uname -a
		{noformat}

		And paste the output into the bug report.

		h3. Compiler Version

		From the command-line, execute this command.

		{noformat}
		g++ -v
		{noformat}

		And paste the last line into the report.

		h3. Run Log

		On Unix, a command such as the following will create a log file.

		On Unix, a command such as the following will create a log file for your job.
		{noformat}
		slic [args] &> job_log.txt
		{noformat}
		Please attach this to the bug report or paste in the relavent sections (if reasonably short).

		Please attach this to the bug report.

		h3. Input StdHep File

		It is vitally important that the StdHep file be listed in the bug report, because many types of errors can occur from malformed or incorrectly processed StdHep files.
		It is vitally important that the StdHep file be specified in the bug report, because many types of errors can occur from malformed or incorrectly processed StdHep files.

		If using a "standard" LCD StdHep file from the public data area, give the full FTP URL to that file.

		{noformat}
		ftp://ftp-lcd.slac.stanford.edu/lcd/ILC/ILC500/WW/cdcaug05/slcio/slic/panpyWW-0-500_SLIC_v1r9p4_cdcaug05.slcio
		{noformat}

		If the StdHep file was produced by you, place it in an accessible location, such as a WWW URL.

		If the StdHep file was produced by you, place it in an accessible location, such as a WWW URL.
		{noformat}
		http://www.example.org/path/to/MyStdHepFile.stdhep
		{noformat}
		Additionally, include the name of the generator(s) that were used (e.g. WHIZARD, PandoraPythia, GRACE, HERWIG, etc.) and the configuration(s) used to produce the file.

		Additionally, include the name of the generator(s) (e.g. WHIZARD, PandoraPythia, GRACE, HERWIG, etc.) and the configuration(s) used to produce the file.

		h3. LCIO File

		Some bugs prevent the creation of the LCIO file.

		In the case where an LCIO file was produced, please point to it using the same conventions as listed for StdHep files.
		In the case where an LCIO file was produced, please point to it using the same conventions as given for the StdHep files.

		h3. Event Number or List

		Oftentimes, errors will occur only on certain event numbers. Please list the event numbers that will reproduce the error in question.
		Oftentimes, errors will occur only on certain event numbers. Please list the event numbers that produce the error in question.

		h3. Repeating the Error

		If special steps are required to repeat the error, please list them.
		If special steps are required to repeat the error, please list them.

		h2. Caveats

		Older versions of SLIC and the corresponding Geant4 versions are considered deprecated. If you are using an older version, please consider upgrading to the latest versions of SLIC and LCDD and attempt to repeat the error with this configuration.