Metadata-Version: 2.1
Name: cell_feature_data
Version: 1.0.5
Summary: A Python package for creating a dataset for the Cell Feature Explorer.
Author-email: Ruge Li <ruge.li@alleninstitute.org>
License: MIT License
Classifier: Development Status :: 4 - Beta
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click>=8.1.7
Requires-Dist: mypy-extensions>=1.0.0
Requires-Dist: numpy>=1.26.3
Requires-Dist: packaging>=23.2
Requires-Dist: pandas>=2.1.4
Requires-Dist: pathspec>=0.12.1
Requires-Dist: platformdirs>=4.1.0
Requires-Dist: prompt-toolkit>=3.0.36
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pytz>=2023.3.post1
Requires-Dist: questionary>=2.0.1
Requires-Dist: six>=1.16.0
Requires-Dist: tzdata>=2023.4
Requires-Dist: wcwidth>=0.2.13
Requires-Dist: black>=22.3.0
Requires-Dist: check-manifest>=0.48
Provides-Extra: lint
Requires-Dist: flake8>=4.0.1; extra == "lint"
Requires-Dist: flake8-debugger>=3.2.1; extra == "lint"
Requires-Dist: flake8-typing-imports>=1.9.0; extra == "lint"
Requires-Dist: flake8-pyproject>=0.4.0; extra == "lint"
Provides-Extra: test
Requires-Dist: coverage>=5.1; extra == "test"
Requires-Dist: pytest>=7.1.2; extra == "test"
Requires-Dist: pytest-cov>=4.0.0; extra == "test"
Requires-Dist: pytest-raises>=0.11; extra == "test"
Provides-Extra: all
Requires-Dist: flake8>=4.0.1; extra == "all"
Requires-Dist: flake8-debugger>=3.2.1; extra == "all"
Requires-Dist: flake8-typing-imports>=1.9.0; extra == "all"
Requires-Dist: flake8-pyproject>=0.4.0; extra == "all"
Requires-Dist: coverage>=5.1; extra == "all"
Requires-Dist: pytest>=7.1.2; extra == "all"
Requires-Dist: pytest-cov>=4.0.0; extra == "all"
Requires-Dist: pytest-raises>=0.11; extra == "all"

# Cell Feature Data

[![Dataset validation](https://github.com/allen-cell-animated/cell-feature-data/actions/workflows/validate.yml/badge.svg?branch=main)](https://github.com/allen-cell-animated/cell-feature-data/actions/workflows/validate.yml)


**Python Package for Creating and Validating Cell Feature Datasets for [Cell Feature Explore](https://cfe.allencell.org/)**

---

## Documentation

For full documentation, please see the [full documentation on Github](https://github.com/allen-cell-animated/cell-feature-data).


## Installation

```pip install cell-feature-data```

## Usage
### Create a single dataset or a megaset for the Cell Feature Explore:

Run the following command in your terminal:
```create-dataset```

### This command will guide you through the following steps: 
  1. **Specify the Path to the Input File:** 
      Supported formats: `.csv` (with more formats to be added in future releases).
  2. **Set the Output Directory:**
      Provide a path to save the generated dataset files. If not specified, a new dataset folder will be created in the `data` directory, named after the input file.
  3. **Process the input file:**
      The tool will calculate and generate the necessary JSON files based on the input data.
  4. **Enter Additional Metadata:** 
      You will be prompted to add more details about the dataset, which will be used to update the generated JSON files.

### Import and use the package within your python scripts:
```
   from cell_feature_data.bin.create_dataset import main


   # Call the main function
   if __name__ == "__main__":
      main()
```

## Dataset Specification 
For more information on the dataset structure and settings, refer to the [Full spec documentation](https://allen-cell-animated.github.io/cell-feature-data/HandoffSpecification.html)
