.. gettingstarted

Getting Started
===============

.. toctree::
   :hidden:

   quickstart
   serializing
   running
   customize
   examples


.. installation:

Installation
------------

.. code-block:: bash
    
   pip install canesm-process


If you want to help develop this package use

.. code-block:: bash

   git clone git@gitlab.com:LandonRieger/canesm-processor.git
   cd canesm-processor
   pip install -e .[dev]


This will install optional dependencies for testing (``pytest``), code formatting (``black``) and documentation (``sphinx``).