Metadata-Version: 2.4
Name: parcellate
Version: 0.1.1
Summary: A simple tool for extracting regional statistics from scalar neuroimaging maps.
Project-URL: Homepage, https://GalKepler.github.io/parcellate/
Project-URL: Repository, https://github.com/GalKepler/parcellate
Project-URL: Documentation, https://GalKepler.github.io/parcellate/
Author-email: Gal Kepler <galkepler@gmail.com>
License-File: LICENSE
Keywords: python
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: <4.0,>=3.9
Requires-Dist: nibabel>=5.3.2
Requires-Dist: nilearn>=0.12.1
Requires-Dist: numpy>=2.0.2
Requires-Dist: pandas>=2.3.3
Requires-Dist: pybids>=0.20.0
Requires-Dist: seaborn>=0.13.2
Requires-Dist: tomli>=2.3.0
Description-Content-Type: text/markdown

# Overview

| Property | Tools & Grades
| :------- | :------:
| docs     | [![docs](https://readthedocs.org/projects/neuroparcellate/badge/?version=latest)](https://neuroparcellate.readthedocs.io/en/latest/?version=latest)
| tests, CI & coverage  | [![Build status](https://img.shields.io/github/actions/workflow/status/GalKepler/parcellate/main.yml?branch=main)](https://github.com/GalKepler/parcellate/actions/workflows/main.yml?query=branch%3Amain), [![codecov](https://codecov.io/gh/GalKepler/parcellate/branch/main/graph/badge.svg)](https://codecov.io/gh/GalKepler/parcellate), [![Codacy Badge](https://app.codacy.com/project/badge/Grade/38a53841e1f842b1b4c80913aee026c3)](https://app.codacy.com/gh/GalKepler/parcellate/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
| activity  | [![Commit activity](https://img.shields.io/github/commit-activity/m/GalKepler/parcellate)](https://img.shields.io/github/commit-activity/m/GalKepler/parcellate)
| license   | [![License](https://img.shields.io/github/license/GalKepler/parcellate)](https://img.shields.io/github/license/GalKepler/parcellate)


A simple tool for extracting regional statistics from scalar neuroimaging maps.

- **Github repository**: <https://github.com/GalKepler/parcellate/>
- **Documentation** <https://GalKepler.github.io/parcellate/>

## Getting started with your project

### 1. Create a New Repository

First, create a repository on GitHub with the same name as this project, and then run the following commands:

```bash
git init -b main
git add .
git commit -m "init commit"
git remote add origin git@github.com:GalKepler/parcellate.git
git push -u origin main
```

### 2. Set Up Your Development Environment

Then, install the environment and the pre-commit hooks with

```bash
make install
```

This will also generate your `uv.lock` file

### 3. Run the pre-commit hooks

Initially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:

```bash
uv run pre-commit run -a
```

### 4. Commit the changes

Lastly, commit the changes made by the two steps above to your repository.

```bash
git add .
git commit -m 'Fix formatting issues'
git push origin main
```

You are now ready to start development on your project!
The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.

To finalize the set-up for publishing to PyPI, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/publishing/#set-up-for-pypi).
For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/mkdocs/#enabling-the-documentation-on-github).
To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/codecov/).

## Releasing a new version

- Create an API Token on [PyPI](https://pypi.org/).
- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/GalKepler/parcellate/settings/secrets/actions/new).
- Create a [new release](https://github.com/GalKepler/parcellate/releases/new) on Github.
- Create a new tag in the form `*.*.*`.

For more details, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/cicd/#how-to-trigger-a-release).

---

Repository initiated with [fpgmaas/cookiecutter-uv](https://github.com/fpgmaas/cookiecutter-uv).
# parcellate
