Skip to main content

ticdat

Go here for project status and installation instructions. Go here for documentation.

ticdat is a Python package that provides lightweight, ORM style functionality around either a dict-of-dicts or pandas.DataFrame representation of tables. It is well suited for defining and validating the input data for complex solve engines (i.e. optimization and scheduling-type problems).

ticdat functionality is organized around two classes - TicDatFactory and PanDatFactory. Both classes define a simple database style schema on construction. Data integrity rules can then be added in the form of foreign key relationships, data field types (to include numerical ranges and allowed strings) and row predicates (functions that check if a given row violates a particular data condition). The factory classes can then be used to construct TicDat/PanDat objects that contain tables consistent with the defined schema. By design, ticdat, allows these data objects to violate the data integrity rules while providing convenient bulk query functions to determine where those violations occur.

TicDat objects (created by a TicDatFactory) contain tables in a dict-of-dict format. The outer dictionary maps primary key values to data rows. The inner dictionaries are data rows indexed by field names (similar to csv.DictReader/csv.DictWriter). Tables that do not have primary keys are rendered as a list of data row dictionaries.

PanDat objects (created by PanDatFactory) render tables as pandas.DataFrame objects. The columns in each DataFrame will contain all of the primary key and data fields that were defined in the PanDatFactory schema. The PanDatFactory code can be thought of as implementing a shim library that organizes DataFrame objects into a predefined schema, and facilitates rich integrity checks based on schema defined rules.

The ticdat example library is focused on two patterns for building optimization engines - using TicDatFactory in conjunction with gurobipy and using PanDatFactory in conjunction with amplpy. That said, ticdat can also be used with libraries like pyomo, pulp, docplex and xpress. It also has functionality to support the OPL and LINGO modeling languages, although the AMPL support is far more mature.

ticdat is also useful for machine-learning applications. In this case, one typically uses PanDatFactory to provide ORM-like functionality on top of pandas, as well as to simplify the munging of time stamp data and text columns that contain exclusively numbers.

The ticdat library is distributed under the BSD2 open source license.

Metadata

Release files for ticdat 0.2.28

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ticdat 0.2.28
File Size Uploaded Provenance Actions
ticdat-0.2.28.tar.gz 199.5 kB Without provenance Details for ticdat-0.2.28.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ticdat 0.2.28
File Interpreter ABI Platform Actions
ticdat-0.2.28-py2.py3-none-any.whl Python 2, Python 3 none any Details for ticdat-0.2.28-py2.py3-none-any.whl

Total release size: 419.8 kB

Release files / ticdat-0.2.28.tar.gz

Download URL ticdat-0.2.28.tar.gz
Size 199.5 kB
Tags Source
SHA-256 checksum
How to use checksums
364b26895837114ff405654f4156b133f07f8e1be4f2a1e3ace0e319e925e131
BLAKE2b-256 checksum
How to use checksums
269a131bcbc21c0c266da9931b27c69c8e24deb5db7d84eecb03f5b98b24e896
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.12.2

Release files / ticdat-0.2.28-py2.py3-none-any.whl

Download URL ticdat-0.2.28-py2.py3-none-any.whl
Size 220.2 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
3714b3c2b390cf9c6e0fe587dbc29ea3a080024d9392cfd561fbf42931752a85
BLAKE2b-256 checksum
How to use checksums
d86c2bf25215355fe2cda3b1c8bbe632bdd7fdfd0dcf7e8ef686a4181e825096
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.12.2

Security for ticdat 0.2.28

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page