Skip to content

Latest commit

 

History

History
196 lines (155 loc) · 23.8 KB

README.md

File metadata and controls

196 lines (155 loc) · 23.8 KB

tedana: TE Dependent ANAlysis

Latest Version PyPI - Python Version JOSS DOI Zenodo DOI License CircleCI Documentation Status Codecov Average time to resolve an issue Percentage of issues still open Join the chat on Mattermost Join our Google Group mailing list All Contributors Code style: black

TE-dependent analysis (tedana) is a Python library for denoising multi-echo functional magnetic resonance imaging (fMRI) data. tedana originally came about as a part of the ME-ICA pipeline, although it has since diverged. An important distinction is that while the ME-ICA pipeline originally performed both pre-processing and TE-dependent analysis of multi-echo fMRI data, tedana now assumes that you're working with data which has been previously preprocessed.

http://tedana.readthedocs.io/

More information and documentation can be found at https://tedana.readthedocs.io.

Citing tedana

If you use tedana, please cite the following papers, as well as our most recent Zenodo release:

Installation

Use tedana with your local Python environment

You'll need to set up a working development environment to use tedana. To set up a local environment, you will need Python >=3.8 and the following packages will need to be installed:

You can then install tedana with

pip install tedana

Creating a miniconda environment for use with tedana

In using tedana, you can optionally configure a conda environment.

We recommend using miniconda3. After installation, you can use the following commands to create an environment for tedana:

conda create -n ENVIRONMENT_NAME python=3 pip mdp numpy scikit-learn scipy
conda activate ENVIRONMENT_NAME
pip install nilearn nibabel
pip install tedana

tedana will then be available in your path. This will also allow any previously existing tedana installations to remain untouched.

To exit this conda environment, use

conda deactivate

NOTE: Conda < 4.6 users will need to use the soon-to-be-deprecated option source rather than conda for the activation and deactivation steps. You can read more about managing conda environments and this discrepancy here.

You can confirm that tedana has successfully installed by launching a Python instance and running:

import tedana

You can check that it is available through the command line interface (CLI) with:

tedana --help

If no error occurs, tedana has correctly installed in your environment!

Use and contribute to tedana as a developer

If you aim to contribute to the tedana code base and/or documentation, please first read the developer installation instructions in our contributing section. You can then continue to set up your preferred development environment.

Getting involved

We 💛 new contributors! To get started, check out our contributing guidelines and our developer's guide.

Want to learn more about our plans for developing tedana? Have a question, comment, or suggestion? Open or comment on one of our issues!

If you're not sure where to begin, feel free to pop into Mattermost and introduce yourself! We will be happy to help you find somewhere to get started.

If you don't want to get lots of notifications, we send out newsletters approximately once per month though our Google Group mailing list. You can view the previous newsletters and/or sign up to receive future ones by joining at https://groups.google.com/g/tedana-newsletter.

We ask that all contributors to tedana across all project-related spaces (including but not limited to: GitHub, Mattermost, and project emails), adhere to our code of conduct.

Contributors

Thanks goes to these wonderful people (emoji key):

Logan Dowdle
Logan Dowdle

💻 💬 🎨 🐛 👀
Elizabeth DuPre
Elizabeth DuPre

💻 📖 🤔 🚇 👀 💡 ⚠️ 💬
Marco Flores-Coronado
Marco Flores-Coronado

🤔 📖
Javier Gonzalez-Castillo
Javier Gonzalez-Castillo

🤔 💻 🎨
Dan Handwerker
Dan Handwerker

🎨 📖 💡 👀 💻
Prantik Kundu
Prantik Kundu

💻 🤔
Ross Markello
Ross Markello

💻 🚇 💬
Pete Molfese
Pete Molfese

💻
Neha Reddy
Neha Reddy

🐛 📖 🤔 💬 👀
Taylor Salo
Taylor Salo

💻 🤔 📖 💬 🐛 ⚠️ 👀
Joshua Teves
Joshua Teves

📆 📖 👀 🚧 💻
Kirstie Whitaker
Kirstie Whitaker

📖 📆 👀 📢
Monica Yao
Monica Yao

📖 ⚠️
Stephan Heunis
Stephan Heunis

📖
Benoît Béranger
Benoît Béranger

💻
Eneko Uruñuela
Eneko Uruñuela

💻 👀 🤔
Cesar Caballero Gaudes
Cesar Caballero Gaudes

📖 💻
Isla
Isla

👀
mjversluis
mjversluis

📖
Maryam
Maryam

📖
aykhojandi
aykhojandi

📖
Stefano Moia
Stefano Moia

💻 👀 📖
Zaki A.
Zaki A.

🐛 💻 📖
Manfred G Kitzbichler
Manfred G Kitzbichler

💻
giadaan
giadaan

📖
Basile
Basile

💻
Chris Markiewicz
Chris Markiewicz

💻
Sarah Goodale
Sarah Goodale

📖 🤔 💬
Maitane Martinez Eguiluz
Maitane Martinez Eguiluz

💻
Marta Arbizu Gómez
Marta Arbizu Gómez

💻
Matteo Visconti di Oleggio Castello
Matteo Visconti di Oleggio Castello

💻 🐛 📖
Robert Smith
Robert Smith

💻 🎨 🤔 👀
Bahman
Bahman

💻 🎨 🤔

This project follows the all-contributors specification. Contributions of any kind welcome! To see what contributors feel they've done in their own words, please see our contribution recognition page.