Skip to content

Commit

Permalink
Last doc bits
Browse files Browse the repository at this point in the history
  • Loading branch information
jzuhone committed Apr 14, 2023
1 parent 2354680 commit 0287ac4
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
2 changes: 1 addition & 1 deletion pyxsim/source_models/power_law_sources.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@


class PowerLawSourceModel(SourceModel):
r"""
"""
Initialize a source model from a power-law spectrum.
Parameters
Expand Down
7 changes: 5 additions & 2 deletions pyxsim/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,25 +88,28 @@ def validate_parameters(first, second, skip=None):


def merge_files(input_files, output_file, overwrite=False, add_exposure_times=False):
r"""
"""
Helper function for merging PhotonList or EventList HDF5 files.
Parameters
----------
input_files : list of strings
List of filenames that will be merged together.
output_file : string
Name of the merged file to be outputted.
overwrite : boolean, default False
If a the output file already exists, set this to True to
If the output file already exists, set this to True to
overwrite it.
add_exposure_times : boolean, default False
If set to True, exposure times will be added together. Otherwise,
the exposure times of all of the files must be the same.
Examples
--------
>>> from pyxsim import merge_files
>>> merge_files(["events_0.h5","events_1.h5","events_3.h5"], "events.h5",
... overwrite=True, add_exposure_times=True)
Notes
-----
Currently, to merge files it is mandated that all of the parameters have the
Expand Down

0 comments on commit 0287ac4

Please sign in to comment.