Skip to content

abrahamnunes/fitr

Repository files navigation

Fitr is currently being rewritten from the ground up to be faster and more flexible. Stay tuned for updates.

Getting Started

Prerequisites

conda install --yes --file requirements.txt

or

pip install -r requirements.txt

Installation

pip install git+https://github.com/abrahamnunes/fitr.git

or

git clone https://github.com/abrahamnunes/fitr.git
cd fitr
python setup.py develop --user

Running Tests

conda install --yes --file requirements_test.txt

or

pip install -r requirements_test.txt

Documentation

  • Full API documentation in the docs/api folder.
  • Detailed documentation in docs/tex/fitr_documentation.pdf

Examples

  • See examples/ folder
  • Tutorials with deeper explanations in docs/tex/fitr_documentation.pdf

Contributing

  • Being Updated

License

  • This project uses the GNU General Public License v3.0 - see the LICENSE.md file for details

How to Cite

If you use Fitr in your work, we would very much appreciate the citation, which can be done as follows: