Metadata-Version: 2.1
Name: tmlt.core
Version: 0.3.3a2
Summary: Tumult's differential privacy primitives
Home-page: https://gitlab.com/tumult-labs/core
License: Apache-2.0
Requires-Python: >=3.7.1,<4.0.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Security
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: numpy (>=1.18.0,<1.19.5)
Requires-Dist: pandas (>=1.2.0,<2.0.0)
Requires-Dist: pyarrow (>=2.0.0,<3.0.0)
Requires-Dist: pyspark[sql] (>=3.0.0,<3.1.0)
Requires-Dist: python-flint (==0.3.0)
Requires-Dist: randomgen (>=1.18.1,<2.0.0)
Requires-Dist: scipy (>=1.4.1,<1.6.1)
Requires-Dist: sympy (>=1.8,<1.10)
Requires-Dist: typeguard (>=2.12.1,<2.13.0)
Requires-Dist: typing_extensions (>=3.10.0.0,<4.0.0.0)
Project-URL: Documentation, https://docs.tmlt.dev/core/latest
Project-URL: Repository, https://gitlab.com/tumult-labs/core
Description-Content-Type: text/markdown

# Tumult Core

Tumult Core is a programming framework for implementing [differentially private](https://en.wikipedia.org/wiki/Differential_privacy) algorithms.

The design of Tumult Core is based on the design proposed in the [OpenDP White Paper](https://projects.iq.harvard.edu/files/opendifferentialprivacy/files/opendp_white_paper_11may2020.pdf), and can automatically verify the privacy properties of algorithms constructed from Tumult Core components. Tumult Core is scalable, includes a wide variety of components, and supports multiple privacy definitions.

## Installation

See the [installation instructions in the documentation](https://docs.tmlt.dev/core/latest/installation.html#installation-instructions) for information about setting up prerequisites such as Spark and python-flint.

Once the prerequisites are installed, you can install Tumult Core using [pip](https://pypi.org/project/pip/).

```bash
pip install tmlt.core
```

## Documentation

The full documentation is located at https://docs.tmlt.dev/core/latest.

## Support

If you have any questions/concerns, please [create an issue](https://gitlab.com/tumult-labs/core/-/issues) or reach out to [support@tmlt.io](mailto:support@tmlt.io)

## Contributing

We are not yet accepting external contributions, but please let us know at [support@tmlt.io](mailto:support@tmlt.io) if you are interested in contributing.

See [CONTRIBUTING.md](CONTRIBUTING.md) for information about installing our development dependencies and running tests.


## License

Copyright Tumult Labs 2022

The Tumult Platform source code is licensed under the Apache License, version 2.0 (Apache-2.0).
The Tumult Platform documentation is licensed under
Creative Commons Attribution-ShareAlike 4.0 International (CC-BY-SA-4.0).

