.. image:: support/Logo_OCECgo.png
   :scale: 40 %
   :align: center

---------------------

*OCECgo* is a MatLab-based software tool for the quantification of uncertainties in the calibration and data analysis of the Sunset Laboratory Model 4 semi-continuous thermal-optical organic/elemental carbon analyzer.

.. toctree::
  :caption: Table of Contents
  :maxdepth: 2

  Calibration <support/calibration>
  Data Analysis <support/dataanalysis>
  Algorithm Details <support/algorithmdetails>

****************
Citation and Use
****************

*OCECgo* is described in an article submitted to the `Journal of Visualized Experiments <http://www.jove.com>`_ and is being shared free of charge under the :ref:`MIT license <AnchorToLicense>`.  When using the software for analysis of data in published work, it is requested that users cite/acknowledge the following:

  Conrad, B.M. & Johnson, M.R., Calibration Protocol and Software for Split Point Analysis and Uncertainty Quantification of Thermal-Optical Organic / Elemental Carbon Measurements, **J. Vis. Exp.** (2019), *submitted*.

********
Features
********

.. include:: README.rst
  :start-after: features-start
  :end-before: features-end

.. note::

  Portions of the below text will be edited upon public release of the software.

************
Installation
************

*OCECgo* is available as a source distribution and a build distribution.  If you have a MatLab license (R2016a or newer), add the "MatLab_Source_Code" and its subfolders to the MatLab path and run "OCECgo". Alternatively, double-click the "OCECgo_webinstaller" executable to install a standalone version of the software on your computer.

.. note::

  GitHub instructions to be added when the software is released.

.. note::

  When booting the software, the landing screen may disappear and it may seem as though booting has stalled. Be patient at this point; the MatLab runtime is being loaded and *OCECgo* will initialize shortly after.

Requirements
============

*OCECgo* was originally developed and has been tested in MatLab R2016a and R2018b, and uses the *signal_toolbox* and *statistics_toolbox*.

If you encounter issues during installation or when using *OCECgo*, please contact the author.

**********
Contribute
**********

*OCECgo* is intended be a research tool that improves over time - your input to introduce and improve functionality would be highly appreciated! Consider contributing in the following ways:

  1. Have a bug report? Raise an issue on github.

  2. Want to introduce functionality helpful to your work/field? Fork the repository, make it work for you, and issue a pull request. Credit will always be given!

.. _AnchorToLicense:

*******
License
*******

*OCECgo* is licensed under the **MIT** license:

  .. include:: ../LICENSE.txt

**************************
Author Contact Information
**************************

You can contact Bradley (Brad) Conrad with issues and/or recommendations at brad.conrad@carleton.ca or brad.m.conrad@gmail.com

****************
Revision History
****************

**Version 0.9**: Version submitted for review with JoVE Article.

****************
Acknowledgements
****************

*OCECgo* was developed at Carleton University's `Energy and Emissions Research Laboratory <http://www.carleton.ca/eerl>`_ with support from `NSERC FlareNet <http://www.flarenet.ca>`_.

.. image:: support/Logo_EERL.png
   :scale: 40 %
   :align: center
   :target: http://www.carleton.ca/eerl

|

.. image:: support/Logo_FlareNet.png
   :scale: 40 %
   :align: center
   :target: http://www.flarenet.ca
