Getting Started

Installation

Eventually I will break the distributions up so you don’t have to necessarily install some of the more tangential modules. For right now, everything is in one package.

Enter pip install CalSciPy in your terminal.

If you want to use gpu-parallelization, you will need to install CuPy by following these instructions.

Limitations

The current implementation is partially finished. Please be patient, this is a pet-project, I have a newborn, and I need to finish my thesis. Until things are more finalized, I’ll explicitly note which modules are stable, have >90% test coverage, and are ready-to-use. Anything not explicitly listed as stable should be considered experimental and should be used at your own risk. If you really need something labeled experimental I can probably provide offline code that will probably prove more useful short-term. While the majority of features are already written, they need to be refined for maintainability, readability, and to remove any bugs.

Stable Modules

The following modules are stable as of the indicated version. New features added will be demarcated with a version added tag in the documentation and there will be no further breaking changes.

• color_scheme 0.7.5

• events 0.7.5

• images 0.7.5

• io_tools 0.7.5

• traces 0.7.5

Unstable Modules

These modules are considered unstable. They may be experimental, undocumented, untested, or unfinished.

• bruker

• conversion

• interactive

• optics

• optogenetics

• organization

• roi_tools