Metadata-Version: 2.1
Name: microcat
Version: 0.3.6
Summary: a computational toolbox to identificated microbiome from Omics
Home-page: https://github.com/ChangxingSu/MicroCAT
Author: Changxing Su
Author-email: changxingsu42@gmail.com
License: GPLv3+
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Description-Content-Type: text/markdown
License-File: LICENSE


# MicroCAT

<div align="center">

# MicroCAT

</div>

Microbial Information from Cell Resolution Omics Computational Analysis Toolbox

## Introduction

MicroCAT is a comprehensive computational toolbox designed specifically for microbiome data analysis, capable of extracting microbial information at cellular resolution. This toolbox integrates multiple analytical methods to help researchers process and interpret microbial data more efficiently.

## Table of contents

- [Introduction](#introduction)
- [Installation](#installation)
- [Documentation](#documentation)
- [Citation](#citation)
- [Contact](#contact)
- [Community Contributions](#community-contributions)

## 📦 Installation

MicroCAT runs on Python 3.8 and above. We provide several installation methods:

### Conda Installation (Recommended)
```
conda create -n MICROCAT -c bioconda microcat
```
If you don't have conda in your environment, we recommend installing it first. See the [official conda documentation](https://docs.conda.io/projects/conda/en/latest/user-guide/install/) for installation instructions.

### Pip Installation
Use [pip](https://pip.pypa.io/en/stable/installation/) to quickly install microcat from [PyPI](https://pypi.org/):
```
pip install microcat
```
Then install the software required to run microcat, or use the '--use-conda' parameter during execution to automatically build the runtime environment (see [microcat's official documentation](https://github.com/zhaofangyuan98/MicroCAT/wiki/MicroCAT-Tutorial)).


### Docker Image

> Docker image is still under construction, please be patient.

## 📄 Documentation

For detailed usage methods and parameter descriptions, please refer to [microcat's official documentation](https://github.com/zhaofangyuan98/MicroCAT/wiki/MicroCAT-Tutorial).

The official documentation includes:
- Detailed installation guide
- Input data format requirements
- Analysis module descriptions
- Parameter details
- Results interpretation
- Frequently asked questions
- Case tutorials

A Chinese version of this documentation is available at [README_CN.md](./README_CN.md).

## 📄 Citation

If you use MicroCAT in your research, please cite our paper (forthcoming).

```bibtex
@article{microcat,
  title={MicroCAT: Microbial Information from Cell Resolution Omics Computational Analysis Toolbox},
  author={},
  journal={},
  year={2025}
}
```

## 📧 Contact

If you have any questions, please feel free to contact us.

Email: [changxingsu42@gmail.com](mailto:changxingsu42@gmail.com) or [12231359@mail.sustech.edu.cn](mailto:12231359@mail.sustech.edu.cn) 😃

## 💪 Community Contributions

We welcome your participation in the development of MicroCAT! You can contribute in the following ways:

- Report issues and make suggestions
- Submit code improvements
- Improve documentation
- Share your user experience

For specific contribution methods, please refer to [microcat's official documentation](https://github.com/zhaofangyuan98/MicroCAT/wiki/MicroCAT-Tutorial).

Thank you to all contributors for your support and help!
