File: sec_getting_started.rst

package info (click to toggle)
pyscanfcs 0.3.2%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 1,380 kB
  • sloc: python: 2,669; makefile: 48; sh: 11
file content (21 lines) | stat: -rw-r--r-- 995 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
===============
Getting started
===============

Installation
------------
- Windows installers for PyScanFCS are available at the `release page <https://github.com/FCS-analysis/PyScanFCS/releases>`_.
  Note: The installer is currently broken because astropy cannot be frozen, see https://github.com/astropy/astropy/issues/7052.
- On Debian-based systems, install via ``apt-get install pyscanfcs``.
- If you have Python 3.6 installed, you may install PyScanFCS via ``pip install pyscanfcs``.
  After the installation, type ``pyscanfcs`` in a command shell to start PyScanFCS.


Documentation
-------------
The documentation is in the process of being transferred entirely to
readthedocs.org. Currently, the it is scattered across several
places and it might be outdated:

- Original LaTeX-based PDF file: https://github.com/FCS-analysis/PyScanFCS/wiki/PyScanFCS_doc.pdf
- Book chapter in *Methods in Molecular Biology* (2013) on perpendicular line scanning FCS: https://arxiv.org/abs/1806.00070