Skip to content

Commit

Permalink
Make species argument optional in diagnostics (#105)
Browse files Browse the repository at this point in the history
* Make `species` argument optional

* Update docstring
  • Loading branch information
RemiLehe authored Sep 12, 2023
1 parent a73a0f1 commit d08adcc
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions PICMI_Python/diagnostics.py
Original file line number Diff line number Diff line change
Expand Up @@ -163,8 +163,8 @@ class PICMI_ParticleDiagnostic(_ClassWithInit) :
period: integer
Period of time steps that the diagnostic is performed
species: species instance or list of species instances
Species to write out.
species: species instance or list of species instances, optional
Species to write out. If not specified, all species are written.
Note that the name attribute must be defined for the species.
data_list: list of strings, optional
Expand All @@ -187,7 +187,7 @@ class PICMI_ParticleDiagnostic(_ClassWithInit) :
Sets the base name for the diagnostic output files
"""

def __init__(self, period, species, data_list=None,
def __init__(self, period, species=None, data_list=None,
write_dir = None,
step_min = None,
step_max = None,
Expand Down Expand Up @@ -287,8 +287,8 @@ class PICMI_LabFrameParticleDiagnostic(_ClassWithInit):
dt_snapshots: float
Time between each snapshot in lab frame
species: species instance or list of species instances
Species to write out.
species: species instance or list of species instances, optional
Species to write out. If not specified, all species are written.
Note that the name attribute must be defined for the species.
data_list: list of strings, optional
Expand Down

0 comments on commit d08adcc

Please sign in to comment.