<commit_before>===============================================
Introduction
===============================================

|travis-status|  |appveyor-status|  |coverage|  |doc|

Testbeam analysis is a simple to use software to analyse pixel-sensor data taken in a particle-beam telescope-setup. All steps of a complete analysis
are implemented with a few independent python functions. For a quick first impression check the examples in the documentation.

In future releases it is forseen to:
  - Implement a Kalman Filter
  - Enhance the alignments
  - Add a GUI

Installation
============
You have to have Python 2/3 with the following modules installed:
  - cython
  - tables
  - scipy
  - matplotlib
  - numba

If you are new to Python please look at the installation guide in the wiki.
Since it is recommended to change example files according to your needs you should install the module with

.. code-block:: bash

   python setup.py develop

This does not copy the code to a new location, but just links to it.
Uninstall:

.. code-block:: bash

   pip uninstall testbeam_analysis


Example usage
==============
Check the examples folder with data and examples of a Mimosa26 and a FE-I4 telescope analysis.
Run eutelescope_example.py or fei4_telescope_example.py in the example folder and check the text output to
the console as well as the plot and data files that are created to understand what is going on.
In the examples folder type e.g.:

.. code-block:: bash
   
   python fei4_telescope_example.py

.. |travis-status| image:: https://travis-ci.org/SiLab-Bonn/testbeam_analysis.svg?branch=development
    :target: https://travis-ci.org/SiLab-Bonn/testbeam_analysis
    :alt: Build status
    
.. |appveyor-status| image:: https://ci.appveyor.com/api/projects/status/github/SiLab-Bonn/testbeam_analysis
    :target: https://ci.appveyor.com/project/DavidLP/testbeam-analysis
    :alt: Build status

.. |doc| image:: https://img.shields.io/badge/documentation--blue.svg
    :target: http://silab-bonn.github.io/testbeam_analysis
    :alt: Documentation
    
.. |coverage| image:: https://coveralls.io/repos/SiLab-Bonn/testbeam_analysis/badge.svg?branch=development
    :target: https://coveralls.io/github/SiLab-Bonn/testbeam_analysis?branch=development
    :alt: Coverage

<commit_msg>DOC: show branch specific appveyor status badge<commit_after>===============================================
Introduction
===============================================

|travis-status|  |appveyor-status|  |coverage|  |doc|

Testbeam analysis is a simple to use software to analyse pixel-sensor data taken in a particle-beam telescope-setup. All steps of a complete analysis
are implemented with a few independent python functions. For a quick first impression check the examples in the documentation.

In future releases it is forseen to:
  - Implement a Kalman Filter
  - Enhance the alignments
  - Add a GUI

Installation
============
You have to have Python 2/3 with the following modules installed:
  - cython
  - tables
  - scipy
  - matplotlib
  - numba

If you are new to Python please look at the installation guide in the wiki.
Since it is recommended to change example files according to your needs you should install the module with

.. code-block:: bash

   python setup.py develop

This does not copy the code to a new location, but just links to it.
Uninstall:

.. code-block:: bash

   pip uninstall testbeam_analysis


Example usage
==============
Check the examples folder with data and examples of a Mimosa26 and a FE-I4 telescope analysis.
Run eutelescope_example.py or fei4_telescope_example.py in the example folder and check the text output to
the console as well as the plot and data files that are created to understand what is going on.
In the examples folder type e.g.:

.. code-block:: bash
   
   python fei4_telescope_example.py

.. |travis-status| image:: https://travis-ci.org/SiLab-Bonn/testbeam_analysis.svg?branch=development
    :target: https://travis-ci.org/SiLab-Bonn/testbeam_analysis
    :alt: Build status
    
.. |appveyor-status| image:: https://ci.appveyor.com/api/projects/status/github/SiLab-Bonn/testbeam_analysis/branch/development
    :target: https://ci.appveyor.com/project/DavidLP/testbeam-analysis/branch/development
    :alt: Build status

.. |doc| image:: https://img.shields.io/badge/documentation--blue.svg
    :target: http://silab-bonn.github.io/testbeam_analysis
    :alt: Documentation
    
.. |coverage| image:: https://coveralls.io/repos/SiLab-Bonn/testbeam_analysis/badge.svg?branch=development
    :target: https://coveralls.io/github/SiLab-Bonn/testbeam_analysis?branch=development
    :alt: Coverage


{'fraction_non_alphanumeric': 0.1296058269065981, 'fraction_numerical': 0.0029991431019708655, 'mean_word_length': 4.102732240437159, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 14, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1810596', 'n_tokens_mistral': 1404, 'n_tokens_neox': 1326, 'n_words': 470}