Skip to content

Latest commit

 

History

History
150 lines (99 loc) · 3.88 KB

index.rst

File metadata and controls

150 lines (99 loc) · 3.88 KB

Welcome to pypet's documentation!

The new python parameter exploration toolbox. pypet manages exploration of the parameter space and data storage into HDF5 files for you.

IMPORTANT!

The current program is a BETA version, please treat it as such and use very carefully.

Moreover, you WILL NOT be able to use trajectories that were created with the ALPHA version any more. I am sorry if you have already explored a lot of parameter spaces. If this bugs you a lot, let me know and I'll take a look whether I could write a converter.

Note that until the 0.1.0 version there still might be some changes to the API. Yet, with 0.1.0 I will guarantee a stable API.

I decided to integrate pypet first in my own research project before publishing the official 0.1.0 release. Thus, I have a more profound testing environment than only using unittests. The official 0.1.0 release is postponed to beginning of next year or end of this year. However, feel free to use this beta version and feel free to give feedback, suggestions, and report bugs. Either write my an email (robert.meyer (at) ni.tu-berlin.de) or use github (https://github.com/SmokinCaterpillar/pypet) issues :-)

Thanks!

Requirements

Python 2.6 or 2.7

  • tables >= 2.3.1
  • pandas >= 0.12.0
  • numpy >= 1.6.1
  • scipy >= 0.9.0

For git integration you additionally need

  • GitPython

ToC

Contents:

.. toctree::
   :maxdepth: 2

   introduction
   cookbook
   examples
   code




Contact

Robert Meyer

robert.meyer (at) ni.tu-berlin.de

Marchstr. 23

MAR 5.046

D-10587 Berlin

Acknowledgments

  • Thanks to Robert Pröpper and Philipp Meier for answering all my Python Questions.

    You might wanna check out their SpykeViewer tool for visualization of MEA recordings and NEO data

  • Thanks to Owen Mackwood for his SNEP toolbox which provided the initial ideas for this project

  • Thanks to the BCCN Berlin, the Research Training Group GRK 1589/1, and the Neural Information Processing Group for support

Tests

Tests can be found in pypet/tests. Note that they involve heavy file IO and it might not be the case that you have privileges on your system to write files to a temporary folder. The tests suite will make use of the tempfile.gettempdir() function to access a temporary folder.

You can run all tests with $ python all_tests.py which can also be found under pypet/tests. You can pass additional arguments as $ python all_tests.py -k --folder=myfolder/ with -k to keep the hdf5 files created by the tests (if you want to inspect them, otherwise they will be deleted after the completed tests) and --folder= to specify a folder where to store the hdf5 files instead of the temporary one. If the folder cannot be created the program defaults to tempfile.gettempdir().

If you do not want to browse to your installation folder, you can also download :download:`all_tests.py <../../pypet/tests/all_tests.py>`.

Indices and Tables

License

.. literalinclude:: ../../LICENSE