migrate wiki for release 1.0 authored by Calvin Eiber's avatar Calvin Eiber
## Overview
the `+tools` package contains utilities essential for the proper functioning of ViNERS, file I/O, graphics helpers, some statistical utilities, and some other miscellanea. See also [+mesh](Mesh/Overview), [+models](Models/Overview), and [+plots](Plots/Overview).
## Contents
Core utilities:
- [tools.file](file.m)
- [tools.cache](cache.m)
- [tools.configuration](configuration.m)
- [tools.model_status](model_status.m)
- [tools.makeFromTemplate](make_from_template.m)
Data structure management:
- [tools.make_SPARC_subject](make_SPARC_subject.m)
- [tools.gather](gather.m)
Statistical utilities:
- [tools.sequential_F_test](sequential_F_test.m)
- [tools.stat_line](stat_line.m)
Internal utilities:
- `tools.setupChronux` (see http://chronux.org/)
- `tools.setupEIDORS` (see http://eidors3d.sourceforge.net/)
- [tools.opts_to_args](opts_to_args.m)
- `tools.parse_arguments`
- `tools.parse_json`
- `tools.parse_xml`
- `tools.semaphore`
- `tools.from_trajectory`
- `tools.detrend_wave`
- [tools.load_Ve_field](load_Ve_field.m)
- `tools.get_example_cachefiles` (todo: rename)
- `tools.read_NRN_datfile`
Graphics utilities:
- [tools.magma](https://bids.github.io/colormap/)
- `tools.suptitle`
- `tools.tidyPlot`
Other miscellaneous pieces of code:
- `tools.make_SPARC_structure`
- `tools.INPUT_file` (note: I plan to remove this)
- `tools.check_properties`
- `tools.peakseek`
- `tools.printInfo`
- `tools.octave_init`
- `tools.export_H5XP_file`
- `tools.export_NSx_file`
Temporary [Sidebar link](_sidebar)