Commit d30ee690 authored by Jakob Luettgau's avatar Jakob Luettgau
Browse files

Minor updates to documentation (warning, and note markup). Remove some dead code.

parent 932d6999
......@@ -39,10 +39,6 @@ A brief examples showing some of the basic functionality is the following::
darshan.enable_experimental()
report.summarize()
# ...
# Generate a timeline from dxt records
report.read_all_dxt_records()
report.create_timeline() # experimental
Installation
......
......@@ -38,6 +38,7 @@ class DarshanReportJSONEncoder(json.JSONEncoder):
return json.JSONEncoder.default(self, obj)
_structdefs = {
"BG/Q": "struct darshan_bgq_record **",
"DXT_MPIIO": "struct dxt_file_record **",
......@@ -53,8 +54,6 @@ _structdefs = {
class DarshanReport(object):
"""
The DarshanReport class provides a convienient wrapper to access darshan
......@@ -156,7 +155,8 @@ class DarshanReport(object):
"""
Creates a deepcopy of report.
NOTE: Needed to purge reference to self.log as Cdata can not be pickled:
.. note::
Needed to purge reference to self.log as Cdata can not be pickled:
TypeError: can't pickle _cffi_backend.CData objects
"""
......@@ -329,11 +329,6 @@ class DarshanReport(object):
else:
self.records[mod].append(rec)
#c = dict(zip(cn, rec['counters']))
#fc = dict(zip(fcn, rec['fcounters']))
#self.records[mod].append([c])
self.modules[mod]['num_records'] += 1
# fetch next
......@@ -401,12 +396,6 @@ class DarshanReport(object):
return
#_structdefs = {
# "DXT_POSIX": "struct dxt_file_record **",
# "DXT_MPIIO": "struct dxt_file_record **",
#}
self.records[mod] = []
self.modules[mod]['num_records'] = 0
......@@ -437,8 +426,13 @@ class DarshanReport(object):
def mod_records(self, mod, dtype='numpy', warnings=True):
"""
Return generator for lazy record loading and traversal.
WARNING: Can't be used for now when alternating between different modules.
.. warning::
Can't be used for now when alternating between different modules.
A temporary workaround can be to open the same log multiple times,
as this ways buffers are not shared between get_record invocations
in the lower level library.
Args:
mod (str): Identifier of module to fetch records for
......
......@@ -4,14 +4,6 @@ darshan.backend package
Submodules
----------
darshan.backend.ascii\_backend module
-------------------------------------
.. automodule:: darshan.backend.ascii_backend
:members:
:undoc-members:
:show-inheritance:
darshan.backend.cffi\_backend module
------------------------------------
......
......@@ -7,7 +7,9 @@ Subpackages
.. toctree::
darshan.backend
darshan.cli
darshan.experimental
darshan.utils
Submodules
----------
......
......@@ -17,7 +17,7 @@ To use pydarshan in a project::
# Python aggregations are still experimental and have to be activated:
# calculate or update aggregate statistics for currently loaded records
# calculate or update aggregate statistics for currently loaded records
darshan.enable_experimental()
report.summarize()
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment