Metadata-Version: 2.5
Name: beefcot
Version: 1.2.0
Summary: Carcass yield models and cutting plans: one YAML in, one delivered model out
Requires-Python: >=3.13
Requires-Dist: jarvisplot>=2.1
Requires-Dist: numpy>=2.5
Requires-Dist: pandas>=3.0
Requires-Dist: pytest>=8
Requires-Dist: pyyaml>=6.0
Requires-Dist: scikit-learn>=1.9
Requires-Dist: scipy>=1.18
Requires-Dist: threadpoolctl>=3.6
Requires-Dist: xgboost>=3.3
Description-Content-Type: text/markdown

# beefcot

Carcass yield regression models and cutting plans, defined by YAML. Python 3.13
or newer is required.

```bash
python3 -m pip install beefcot
beefcot --help
beefcot validate /path/to/job.yaml
beefcot fit /path/to/job.yaml
beefcot project create HERD
beefcot project validate HERD
```

`beefcot project create` writes one computational project directory. The Web
application, account administration and machine project registry are maintained
in a separate private project and are not included in this package.

## Upgrading to 1.2

The public package provides scientific computation and its CLI. The former
`beefcot serve`, `beefcot user` and `beefcot project add/list/remove` commands
have moved to the private Web application. `beefcot project create/validate`
remain available and do not modify a Web project registry. The scientific
YAML entry points and delivered format-3 model loading remain available.

Each fit starts from a `kind: regression_tree` YAML declaring its input table,
feature and target columns, cut-tree mapping, split and regression space.
Available methods are profile, RF, DNN, ReRF and exhaustive search. Structural
nodes aggregate measured products; data and fitted models are supplied by users.

Delivered format-3 models can be loaded once and called through the NumPy-only
runtime:

```python
from beefcot.runtime import load

model = load("/path/to/delivered/model")
result = model.predict_one(carcass_inputs)
```

The source distribution contains package code, required generic resources,
runtime schemas and build metadata. It contains no animal datasets, fitted
models, reports, machine setup records or development job configurations.

Plotting delegates to the public `jplot plot.yaml` command. Keep `jplot` on the
active environment's PATH; plotting YAML and input tables are retained beside
the generated figures for redrawing. Supported usage is available from
`jplot --help` and `jplot man <topic> --json`.

Development configuration templates, tests and tools are maintained separately
from the installed package. Keep your job YAML, data, outputs and delivered
models in an independent workspace.
