Skip to content

Commit

Permalink
documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
vstadnytskyi committed Oct 11, 2019
1 parent c2a9956 commit 8c7f6fd
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
2 changes: 2 additions & 0 deletions docs/source/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,7 @@ Start by importing Icarus Pressure Jump for NMR.
Data Analysis
-------------------

The icarus analysis submodule allow easy and seamless access to the logged data from the pressure jump experiment. The instantiation of the Dataset class creates a link to a folder allowing easy access to the log file and traces.

Instrumentation
-------------------
6 changes: 4 additions & 2 deletions icarus_nmr/analysis.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@
import pickle

class Dataset():
def __init__(self):
def __init__(self, folder = None):
"""
initializes Dataset class
"""
### Log folder related
self.folder = None #the pointer at the log folder
self.folder = folder #the pointer at the log folder

###Log file related
self.log_header = None #the header retrieved from experiment.log
Expand All @@ -42,6 +42,8 @@ def __init__(self):

#auxiliry variables
self.i = 0
if folder is not None:
self.init()

def init(self):
from time import time
Expand Down

0 comments on commit 8c7f6fd

Please sign in to comment.