Skip to content

Commit

Permalink
Merge pull request #171 from fschuetz04/patch-1
Browse files Browse the repository at this point in the history
Correct arguments for mdfreader.Mdf in readme
  • Loading branch information
ratal authored Nov 25, 2019
2 parents 590c68d + 7f4d1a0 commit a10913c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,11 +87,11 @@ Command example in ipython:
# you can print file content in ipython with a simple:
yop
# alternatively, for max speed and smaller memory footprint, read only few channels
yop=mdfreader.Mdf('NameOfFile', channelList=['channel1', 'channel2'], convertAfterRead=False)
yop=mdfreader.Mdf('NameOfFile', channel_list=['channel1', 'channel2'], convert_after_read=False)
# also possible to keep data compressed for small memory footprint, using Blosc module
yop=mdfreader.Mdf('NameOfFile', compression=True)
# for interactive file exploration, possible to read the file but not its data to save memory
yop=mdfreader.Mdf('NameOfFile', noDataLoading=True) # channel data will be loaded from file if needed
yop=mdfreader.Mdf('NameOfFile', no_data_loading=True) # channel data will be loaded from file if needed
# parsing xml metadata from mdf4.x for many channels can take more than just reading data.
# You can reduce to minimum metadata reading with below argument (no source information, attachment, etc.)
yop=mdfreader.Mdf('NameOfFile', metadata=0) # 0: full, 2: minimal
Expand Down Expand Up @@ -142,4 +142,4 @@ Command example in ipython:
yop.write('NewNameOfFile') # write in same version as original file after modifications
yop.write4('NameOfFile', compression=True) # write mdf version 4.1 file, data compressed
yop.write3() # write mdf version 3 file
```
```

0 comments on commit a10913c

Please sign in to comment.