.. larch documentation master file

==============================
|treelogo| Larch Documentation
==============================

.. image:: https://img.shields.io/conda/vn/conda-forge/larch.svg
    :target: https://anaconda.org/conda-forge/larch
    :class: statusbadge

.. image:: https://img.shields.io/conda/dn/conda-forge/larch
    :target: https://anaconda.org/conda-forge/larch
    :class: statusbadge

.. image:: https://img.shields.io/badge/source-github-yellow.svg
    :target: https://github.com/jpn--/larch
    :class: statusbadge

.. image:: https://img.shields.io/appveyor/ci/jpn--/larch.svg?label=windows%20build
    :target: https://ci.appveyor.com/project/jpn--/larch
    :class: statusbadge

.. image:: https://img.shields.io/travis/jpn--/larch.svg?label=linux%20build
    :target: https://travis-ci.org/jpn--/larch
    :class: statusbadge

.. |treelogo| image:: ../../img/larch_favicon.png
    :height: 0.9em
    :class: treelogo

.. |trophy| image:: ../../img/trophy-64.png
    :class: trophyicon


..

    |trophy|  Winner of the `AGIFORS 56th Annual Symposium Best Innovation award <http://agifors.org/Symposium>`__.

This documentation is for the Python interface for Larch. If this is your first go
with Larch, or the first go on a new computer, you might want to start with :ref:`installation`.

This project is very much under development.  There are plenty of undocumented functions
and features; use them at your own risk.  Undocumented features may be non-functional,
not rigorously tested, deprecated or removed without notice in a future version.  If a
function or method is documented here, it is intended to be stable in future updates.

You may also find these links useful:

* `Python <http://www.python.org/>`_ 3.7: http://docs.python.org/3.7/index.html
* `NumPy <http://www.numpy.org>`__: http://docs.scipy.org/doc/numpy/
* `SciPy <http://www.scipy.org>`__: http://docs.scipy.org/doc/scipy/reference/
* `scikit-learn <https://scikit-learn.org>`__: https://scikit-learn.org/stable/documentation.html

For learning Python itself:

* If you are new to Python but have some experience with some other programming language,
  there is an online quick introduction `Python for Transportation Modeling <https://pytransport.github.io/>`__,
  available free online, sponsored by the Florida Department of Transportation.
* If you are new to programming in general, there are better (slower) guides at
  `Learning Python <http://docs.python-guide.org/en/latest/intro/learning/>`__



Contents
========

.. toctree::
    :maxdepth: 4

    getting-started
    data
    model
    latentclass
    math
    machine-learning/index
    example/examples


