Skip to content

Commit

Permalink
DOC: Initial README
Browse files Browse the repository at this point in the history
  • Loading branch information
effigies committed Jan 18, 2018
1 parent 39d256f commit f6d1ebb
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
FitLins - Fitting Linear Models to fMRI data
============================================

FitLins is a tool for estimating linear models, defined by the `BIDS Model`_
specification proposal, to BIDS-formatted datasets.

This software is in alpha stage, and should be considered unstable.
Users are welcome to test the software, and open issues.

The CLI follows the `BIDS-Apps`_ convention:

Usage::

fitlins/cli/run.py <bids_root> <out_dir> <analysis_level> [--model <model_name>]

See the output of ``fitlins/cli/run.py --help`` for all valid options.

.. _"BIDS Model": https://docs.google.com/document/d/1bq5eNDHTb6Nkx3WUiOBgKvLNnaa5OMcGtD0AZ9yms2M/
.. _BIDS-Apps: http://bids-apps.neuroimaging.io

0 comments on commit f6d1ebb

Please sign in to comment.