Metadata-Version: 2.4
Name: neurodesign-plus
Version: 1.0.2
Summary: Extended and maintained fork of the neurodesign package for fMRI experimental design optimisation
Project-URL: Bug Tracker, https://github.com/SLDlab/neurodesign-plus/issues
Project-URL: Changelog, https://github.com/SLDlab/neurodesign-plus/blob/master/CHANGES.md
Project-URL: Documentation, https://neurodesign-plus.readthedocs.io
Project-URL: Homepage, https://github.com/SLDlab/neurodesign-plus
Project-URL: Repository, https://github.com/SLDlab/neurodesign-plus
Author: Joke Durnez
Author-email: Atharv Amar Umap <aumap@terpmail.umd.edu>, Valentin Guigon <vguigon@umd.edu>
Maintainer-email: Atharv Amar Umap <aumap@terpmail.umd.edu>, Valentin Guigon <vguigon@umd.edu>
License: MIT
License-File: LICENSE
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
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 :: Scientific/Engineering
Classifier: Topic :: Software Development
Requires-Python: >=3.9
Requires-Dist: matplotlib
Requires-Dist: pdfrw
Requires-Dist: reportlab
Requires-Dist: rich
Requires-Dist: scikit-learn>0.15.0
Provides-Extra: dev
Requires-Dist: coverage; extra == 'dev'
Requires-Dist: furo; extra == 'dev'
Requires-Dist: myst-parser>=2.0; extra == 'dev'
Requires-Dist: nbmake; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: pytest>=6.0.0; extra == 'dev'
Requires-Dist: sphinx-autodoc-typehints; extra == 'dev'
Requires-Dist: sphinx-copybutton; extra == 'dev'
Requires-Dist: sphinx>=7.0; extra == 'dev'
Requires-Dist: tox; extra == 'dev'
Provides-Extra: doc
Requires-Dist: furo; extra == 'doc'
Requires-Dist: myst-parser>=2.0; extra == 'doc'
Requires-Dist: sphinx-autodoc-typehints; extra == 'doc'
Requires-Dist: sphinx-copybutton; extra == 'doc'
Requires-Dist: sphinx>=7.0; extra == 'doc'
Provides-Extra: test
Requires-Dist: coverage; extra == 'test'
Requires-Dist: nbmake; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: pytest>=6.0.0; extra == 'test'
Description-Content-Type: text/markdown

# neurodesign-plus

`neurodesign-plus` is an extended and maintained fork of the original [neurodesign](https://github.com/neuropower/neurodesign) package for fMRI experimental design optimisation.

In addition to the base package workflow, `neurodesign-plus` adds support for:

1. fixed user-defined event orders via `order`,
2. variable stimulus durations via `stimuli_durations`,
3. transition-specific ITIs via `conditional_ITI`,
4. probabilistic template-based ordering via `order_keys`, `order_probabilities`, and `order_length`.

## Documentation

- Base package documentation: [neurodesign on Read the Docs](http://neurodesign.readthedocs.io/en/latest/)
- `neurodesign-plus` documentation: [neurodesign-plus on Read the Docs](https://neurodesign-plus.readthedocs.io/en/latest/)

## Repository Layout

```text
docs/        Source files for the Read the Docs documentation
manuals/     Longer-form markdown documentation included by the docs site
neurodesign/ Python package source code
tests/       Automated tests for package behavior
tutorials/   Jupyter tutorials for the main workflow, base functions, and new features
```

## Tutorials

The tutorial collection includes:

- three overview tutorials in `tutorials/`,
- four base-function tutorials in `tutorials/base_functions/`,
- four feature-focused tutorials in `tutorials/new_functions/`.

The Read the Docs tutorials page is the best place to browse the current notebook set and their intended learning progression.

## Credits

This project is a fork of the original **Neurodesign** package.

- Original author: [Neuropower Team](https://github.com/neuropower)
- Primary refactoring, extensions, and tutorials: Atharv Amar Umap (Social Learning and Decisions Lab, UMD) <aumap@terpmail.umd.edu>
- Supervision, design guidance, and tutorials: Valentin Guigon (Social Learning and Decisions Lab, UMD) <vguigon@umd.edu>
