Apread

Updates

- Fixed a typo in interval str (micro and nano seconds was swapped)
- Changed `Group.Interval` unit to seconds

Installation

> THIS IS AN ALPHA RELEASE! USE WITH CARE!

Install

Install this pre-release using:

Parallel reading of data

See `test/testing.py` for a full example. Modify the following around your `APReader` call:

python
import multiprocessing as mp
...


if __name__ == '__main__': this line has to be included!
without 'processes=...'!
pool = mp.Pool()

pass the pool to the reader
reader = APReader(file, parallelPool=pool)

make sure to close the pool after you are done with it
mp.close()
mp.join()


For the parallel loading to work, you have to define a parallel pool of processes in your top-level script. These processes will be accessed from within `APReader`-Functions. When passing no arguments to `mp.Pool()` it will automatically create as many processes as possible, according to the amount of threads your CPU allows (cores + virtual cores). It does not make sense to pass in more, since the `APReader` spawns the same amount of processes as there are CPU Threads. Increasing the amount of processes in your pool does not increase the amount of parallelism. It is fixed.

> Keep in mind, that parallelisation is not always faster. Spawning of processes is expensive and can be wasteful for small files.

The results from `APReader` stay the same and you can continue your analysis.

**Full Changelog**: https://github.com/leonbohmann/APReader/compare/v1.1.0...v1.1.1-alpha1

Changes
Breaking changes

* Removed saving functions, this will be up to the user
> Since these function change a lot based on current needs, I decided to remove the post-processing functionality completely. The user now needs to do the post-processing on his own, meaning the creation of plots using time and data channels...

Changes
* ([hakonbar PR13](https://github.com/leonbohmann/APReader/pull/13)) Differentiate floating point precision
* ([hakonbar PR13](https://github.com/leonbohmann/APReader/pull/13)) Reading additional header information
* ([hakonbar PR13](https://github.com/leonbohmann/APReader/pull/13)) Supplying binary format reference
* Fixed null returning string conversion function
* Using regex to find time channels
* Improved plotting with multiple axes
* Printing channels and groups will now give a summary instead of all data

New Contributors
* hakonbar made their first contribution in https://github.com/leonbohmann/APReader/pull/13

**Full Changelog**: https://github.com/leonbohmann/APReader/compare/v1.0.22...v1.1.0

Summary
This update fixes a couple of issues regarding the availability of time-channels (reference channels).
In rare cases, the time channel is not recognized and therefor a lot of functions depending on it will fail. By asking the user, if a channel with "Seconds [s]" as unit is the time channel of a group, we can work around those errors.

On top of that, even if there is no time channel found, you can now export the data.

**IMPORTANT**
Plotting is not possible, since there is no X-Axis when no time-channel is known. You might need to implement the plotting yourself.

Changes
* Fixed an issue with groups where time channels are not recognized
* now, user is prompted, when suspected time channel is found
* plotting is not possible when there is no time-channel found
* save groups and channels even when there is no time channel

Install
python
pip install apread --upgrade