Metadata-Version: 2.1
Name: nucleus-cdk
Version: 0.3.0a1
Summary: Cell Developer Kit for building synthetic cells and cytosols.
Home-page: https://nucleus.bnext.bio/
License: MIT
Keywords: synthetic biology,synthetic cell,syncell,cellfree,nucleus,cell developer kit
Author: Anton Jackson-Smith
Author-email: anton@bnext.bio
Maintainer: Anton Jackson-Smith
Maintainer-email: anton@bnext.bio
Requires-Python: >=3.12,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Dist: hvplot (>=0.11.1,<0.12.0)
Requires-Dist: jinja2 (>=3.1.4,<4.0.0)
Requires-Dist: jupyter-bokeh (>=4.0.5,<5.0.0)
Requires-Dist: matplotlib (>=3.9.2,<4.0.0)
Requires-Dist: numpy (>=2.1.2,<3.0.0)
Requires-Dist: openpyxl (>=3.1.5,<4.0.0)
Requires-Dist: pandas (>=2.2.3,<3.0.0)
Requires-Dist: rich (>=13.9.2,<14.0.0)
Requires-Dist: scipy (>=1.14.1,<2.0.0)
Requires-Dist: seaborn (>=0.13.2,<0.14.0)
Requires-Dist: timple (>=0.1.8,<0.2.0)
Requires-Dist: tqdm (>=4.66.5,<5.0.0)
Project-URL: Repository, https://github.com/bnext-bio/nucleus/
Description-Content-Type: text/markdown

# CDK: Nucleus Cell Developer Kit
The Nucleus Cell Developer Kit (CDK) is a set of tools and libraries for building synthetic cells, the stack for synthetic cell engineering. This package is the core library, modular code that can be used in specific experiments or in other applications.

Nucleus is an open-source project for building and working with synthetic cells. For more information, please check out the [Nucleus documentation](https://nucleus.bnext.bio/).

## Features
Currently, the CDK contains our core analysis functionality: plate reader and liposome analysis. In particular, the plate reader code is designed to allow for easy analysis of kinetic timeseries of PURE experiments from Agilent/Biotek and Revvity Envision plate readers. The liposome analysis code is under heavy development, and the code included here is somewhat out of date---please contact us for more information.

## Installation
`pip install nucleus-cdk`

## Development
### Install poetry
The CDK uses poetry for dependency control and packaging. Install poetry, and activate it to download the dependencies. You can use poetry to manage the development virtual environment (recommended), or create a new conda environment to develop in.

#### Linux
To install poetry on Linux, you can use the following command:

```bash
curl -sSL https://install.python-poetry.org | python3 -
```

#### Mac
*(untested)* Install poetry using homebrew:
```bash
brew install poetry
```

### Activate poetry and download dependencies
```bash
poetry install
```

