# Change Log
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).

## [3.0.0a1]
### Added
- Conda recipe
- Summary output from `Condition`
- String input to `Experiment`
- Add types to the docs for constants
- `__repr__` for all classes
- Text-file output from relevant trace-type classes
- `reactive_file` is an attribute of `Condition` as a property
- This CHANGELOG file
- Automatic filter cutoff frequency selection and override functions
- Upload docs to gh-pages with [doctr](https://github.com/drdoctr/doctr)
- Disable Cantera thermo warnings after loading a CTI file for the first time
- `volume-trace.yaml` file is automatically written
- Version information is stored in `_version.py`

### Fixed
- Time in figure legend has a colon

### Changed
- Convert all time axes on figures to ms
- Split the dataprocessing module into experiments and conditions modules
- Use slices to compute the derivative of the experimental pressure trace
- A CTI filename is required as input when Condition is instantiated
- The creation of the volume trace is controlled by instance attributes rather than `volume-trace.yaml`
- Minimum version of Cantera is 2.3.0

### Removed
- Voltage traces are no longer smoothed, and the smoothing function has been removed

## [2.1.0] - 2016-05-31
### Added
- Docs for `dataprocessing`
- Matplotlib to intersphinx
- Alternate class for processing experimental data `AltExperiment`
- The year is stored in the `experiment_parameters` dictionary
- Plot the P0 fit line on nonreactive plots
- Axis labels on figures

### Fixed
- Default documentation role is `py:obj`
- Import from `experiment` module should be `dataprocessing` module
- Wrong version in docs
- Get the non-reactive experiment to plot in `create_volume_trace`
- The zeroed time and pressure trace should come from the `pressure_trace` instance in `process_folder`
- Include offset in pressure trace timing calculations
- Documentation typos in filtering function and finding PC
- Using a float as an index to a NumPy array is deprecated, so don't do that

### Changed
- Use online Cantera docs for intersphinx
- The exception generated if calculation of TC fails is printed
- `parse_file_name` is a method of `Experiment`
- Reduce the search increment for finding PC from 100 to 50

### Removed
- `PressureFromVolume` and `VolumeFromPressure` state can no longer be set by P and v

## [2.0.2] - 2016-01-24
### Added
- `Condition` is imported in `__init__.py`

## [2.0.1] - 2016-01-23
### Fixed
- Wrong figure name used in `compare_to_sim`
- Derivative of simulated pressure trace was computed incorrectly

### Changed
- Only get the parameters needed from the YAML file, instead of loading the whole thing every time
- Simulations are plotted with the time-axis in ms and with the zero at EOC

## [2.0.0] - 2016-01-23
### Added
- Sphinx documentation

### Fixed
- Clipboard pasting works on OS X and Windows

### Changed
- Refactor most functionality into classes
- Remove `ParsedFilename` class
- Remove old, unused, modules including `nonreactive.py`, `volume_trace.py`, and `experiments.py`->`dataprocessing.py`
- Set the overall and first stage ignition delays, and the TC of nonreactive experiments to 0

## [1.0.7] - 2016-12-01
### Added
- Low-pass filtering function for the voltage signal
- First stage ignition delay is automatically calculated

### Fixed
- Errors in computing the temperature are caught now, instead of crashing the analysis
- Eliminate deprecation warning about `ReactorNet.step()` by checking the version of Cantera being used

### Changed
- Change offset for ignition delay calculation from 5 ms to 2 ms
- Use FFT convolve from `scipy` instead of `convolve` from `numpy` because the FFT was 100x faster
- The voltage is low-pass filtered and then moving-average smoothed, rather than just being smoothed
- Increase the smoothing window for the derivative from 5 to 151
- The compression time from the YAML file is used as the end time when fitting the initial period of the pressure trace

## [1.0.6] - 2015-07-18
### Added
- Option to specify `end_time` or `end_temp` to the simulation in the class constructor

## [1.0.5] - 2015-07-16
### Added
- Option to plot results in the `ign_loop` script

## [1.0.4] - 2015-07-16
### Fixed
- Bugs related to missing `pathlib` imports in traces files

## [1.0.3] - 2015-07-16
### Added
- New dependency on the `pathlib` module, requiring Python >= 3.4

### Fixed
- The path to search for files to process in `ign_loop` is computed at runtime rather than import-time
- Fix typo in `ParsedFilename` docs

## [1.0.2] - 2015-07-16
### Fixed
- Ignore the build directory

### Changed
- Rename class `PressureTrace` to `ExperimentalPressureTrace`
- The smoothing function sets the first `(span-1)/2` data points equal to the value there
- Refactor `voltage` variable name to be `signal`
- Smooth the voltage first, then compute the pressure, rather than the other way around

## [1.0.1] - 2015-07-16
### Added
- Filename for the reactive experiment is loaded from the `volume-trace.yaml` file

### Fixed
- Minimize code inside with-statement for YAML file
- Ignore `dist` folder from Git

### Changed
- The name of the script to run an analysis of a folder is changed from `process-ignition-loop` to `ignloop`

## [1.0.0] - 2015-06-28
### Added
- Basic functionality of class-based interface to process data

[3.0.0a1]: https://github.com/bryanwweber/UConnRCMPy/compare/v2.1.0...HEAD
[2.1.0]: https://github.com/bryanwweber/UConnRCMPy/compare/v2.0.2...v2.1.0
[2.0.2]: https://github.com/bryanwweber/UConnRCMPy/compare/v2.0.1...v2.0.2
[2.0.1]: https://github.com/bryanwweber/UConnRCMPy/compare/v2.0.0...v2.0.1
[2.0.0]: https://github.com/bryanwweber/UConnRCMPy/compare/v1.0.7...v2.0.0
[1.0.7]: https://github.com/bryanwweber/UConnRCMPy/compare/v1.0.6...v1.0.7
[1.0.6]: https://github.com/bryanwweber/UConnRCMPy/compare/v1.0.5...v1.0.6
[1.0.5]: https://github.com/bryanwweber/UConnRCMPy/compare/v1.0.4...v1.0.5
[1.0.4]: https://github.com/bryanwweber/UConnRCMPy/compare/v1.0.3...v1.0.4
[1.0.3]: https://github.com/bryanwweber/UConnRCMPy/compare/v1.0.2...v1.0.3
[1.0.2]: https://github.com/bryanwweber/UConnRCMPy/compare/v1.0.1...v1.0.2
[1.0.1]: https://github.com/bryanwweber/UConnRCMPy/compare/v1.0.0...v1.0.1
[1.0.0]: https://github.com/bryanwweber/UConnRCMPy/compare/0408b7df57a059e42e946caad4273f808507b9fa...v1.0.0