Synopsis
Save the current Sherpa session to a file.
Syntax
save(filename='sherpa.save', clobber=False)
Examples
Example 1
Save the current session to the file 'sherpa.save'.
>>> save()
Example 2
Save the current session to the file 'bestfit.sherpa', overwriting any existing version of the file.
>>> save('bestfit.sherpa', clobber=True)PARAMETERS
The parameters for this function are:
| Parameter | Type information | Definition |
|---|---|---|
| filename | str, optional | The name of the file to write the results to. The default is 'sherpa.save'. |
| clobber | bool, optional | This flag controls whether an existing file can be overwritten ( True ) or if it raises an exception ( False , the default setting). |
Notes
The current Sherpa session is saved using the Python `pickle` module. The output is a binary file, which may not be portable between versions of Sherpa, but is platform independent, and contains all the data. This means that files created by `save` can be sent to collaborators to share results.
The output of `save` is not guaranteed to work with different versions of Sherpa, so it is not ideal as an archiving format. The `save_all` command is better suited for long-term support, but it unfortunately can not store ancillary variables, extra modules, or all Sherpa settings. It is suggested that the output of both should be checked when the output may be used long term.
Bugs
See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.
See Also
- contrib
- save_chart_spectrum, save_marx_spectrum
- modeling
- clean, save_model, save_source
- saving
- restore, save_all, save_arrays, save_data, save_delchi, save_error, save_filter, save_grouping, save_image, save_pha, save_quality, save_resid, save_staterror, save_syserror, save_table, script