save_all

Context: saving

Synopsis

Save the information about the current session to a text file.

Syntax

save_all(outfile=None, clobber=False)

outfile - str or file-like, optional
clobber - bool, optional

Description

This differs to the `save` command in that the output is human readable. Three consequences are:

numeric values may not be recorded to their full precision
data sets are not included in the file
some settings and values may not be recorded.

Examples

Example 1

Write the current Sherpa session to the screen:

>>> save_all()

Example 2

Save the session to the file 'fit.sherpa', overwriting it if it already exists:

>>> save_all('fit.sherpa', clobber=True)

Example 3

Write the contents to a StringIO object:

>>> from io import StringIO
>>> store = StringIO()
>>> save_all(store)

PARAMETERS

The parameters for this function are:

Parameter	Definition
outfile	If given, the output is written to this file, and the `clobber` parameter controls what happens if the file already exists. `outfile` can be a filename string or a file handle (or file-like object, such as StringIO ) to write to. If not set then the standard output is used.
clobber	If `outfile` is a filename, then this flag controls whether an existing file can be overwritten ( True ) or if it raises an exception ( False , the default setting).

Notes

This command will create a series of commands that restores the current Sherpa set up. It does not save the set of commands used. Not all Sherpa settings are saved. Items not fully restored include:

data created by calls to `load_arrays` , or changed from the version on disk - e.g. by calls to `set_counts` .
any optional keywords to comands such as `load_data` or `load_pha`
user models may not be restored correctly
only a subset of Sherpa commands are saved.

Bugs

See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.