Metadata-Version: 2.4
Name: larch
Version: 6.0.40
Summary: Estimating and applying discrete choice models
Author-email: Jeff Newman <jeff@driftless.xyz>
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.19
Requires-Dist: pandas>=1.5
Requires-Dist: pyarrow
Requires-Dist: xarray
Requires-Dist: numba>=0.60.0
Requires-Dist: numexpr
Requires-Dist: filelock
Requires-Dist: dask
Requires-Dist: networkx
Requires-Dist: addicty
Requires-Dist: xmle>=0.1.25
Requires-Dist: rich
Requires-Dist: sparse
Requires-Dist: scipy
Requires-Dist: Jinja2
Provides-Extra: test
Requires-Dist: pytest>=4.6; extra == "test"
Requires-Dist: jax<0.7,>=0.6; extra == "test"
Requires-Dist: tables; extra == "test"
Requires-Dist: geopandas; extra == "test"
Requires-Dist: matplotlib; extra == "test"
Requires-Dist: seaborn; extra == "test"
Requires-Dist: nbmake; extra == "test"
Requires-Dist: xlsxwriter; extra == "test"
Requires-Dist: zarr; extra == "test"
Requires-Dist: tabulate; extra == "test"
Requires-Dist: altair; extra == "test"
Requires-Dist: vl-convert-python; extra == "test"
Requires-Dist: pydot; extra == "test"
Requires-Dist: pytest-regressions; extra == "test"
Requires-Dist: openmatrix; extra == "test"
Provides-Extra: jax
Requires-Dist: jax; extra == "jax"
Dynamic: license-file

# Larch

This repository contains the Larch package, for estimating and applying discrete
choice models. Version 6 is a substantial rewrite of the package, changing to a
platform that allows swapping out the underlying computational engine, so that
the same model can run in numba or JAX.


# Quick Start Guide

You can install Larch with pip:

```shell
python -m pip install larch
```

# Developer's Installation

You can install larch for development by running the following script:

```shell
curl -LsSf https://driftless.xyz/larch-dev.sh | bash -s -- -d ~/Git/larix
```

You can change the install directory by changing the `-d` argument.  The script
will clone the larch repository and install it in the specified directory.  It
will also install the required dependencies and create a new uv virtual
environment for development.

To run the test suite, you'll need to run with the `--extra test` flag, which
will ensure that all the extra dependencies needed for testing are installed.
To do this, from the `larch` directory, run the following command:

```shell
uv run --extra test pytest .
```
