Skip to main content

Spot-On (cli)

This repository collects a series of scripts to analyze data from single particle tracking experiments. The code was initially written by Anders Sejr Hansen and translated to Python by Maxime Woringer. A Matlab version exists and is maintained by Anders Sejr Hansen.

This repository only includes the commandline analysis pipeline. A graphical user interface (GUI) is available for a more user-friendly analysis, but is not included in this repository. This repository contains the command-line version, that can be used independently from the GUI.

Although the functions and methods can be called directly, we provide a walk-through tutorial as a Jupyter notebook.

Dependencies

  • numpy
  • scipy
  • lmfit

Optional: jupyter

Your package manager may provide precompiled versions of numpy and scipy. In that case, it might be worth using those libraries, because compilation can take a significant amount of time.

Installation (from pip)

pip install fastspt

Installation (from this Gitlab) repository

Install dependencies

pip install -r requirements.txt

Alternatively, you can install the dependencies manually by typing: pip install numpy scipy lmfit

Optional : pip install jupyter

Install fastSPT

Simply run (as root): python setup.py install

Check that it worked: python -c "import fastspt"

Tutorial

A short tutorial, demonstrating the capabilities of the software, is available as a Jupyter notebook.

See fastSPT_tutorial.ipynb. The tutorial is also available online: address of the page

Document here how to open a Jupyter notebook

Usage

Main functions

Extra functions

The writers submodule contains some useful functions:

  • mat_to_csv(in_path, out_path) converts a .mat file to a CSV. It can easily be scripted.

Input file format

Caveats

References

License

This program is released under the GNU General Public License version 3 or upper (GPLv3+).

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

Deploying (developer only)

python setup.py sdist
gpg --detach-sign -a dist/fastspt-11.4.tar.gz
twine upload dist/fastspt-11.4.tar.gz dist/fastspt-11.4.tar.gz.asc

Authors

Maxime Woringer, Anders Sejr Hansen

Bugs/suggestions

Send to bugtracker or to email.

Metadata

Release files for fastspt 16.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for fastspt 16.1
File Size Uploaded Provenance Actions
fastspt-16.1.tar.gz 31.9 kB Without provenance Details for fastspt-16.1.tar.gz

Release files / fastspt-16.1.tar.gz

Download URL fastspt-16.1.tar.gz
Size 31.9 kB
Tags Source
SHA-256 checksum
How to use checksums
5ec0e6ece1226ca42c33c0cf0aa43bcbe8befb09252e2c9cc4a2000a573bcfd6
BLAKE2b-256 checksum
How to use checksums
965a3e60d8062c4d32c6f38f5daf32f96d42bbcd8aa121bf25df0d02139a0bb0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.21.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.7.3

Security for fastspt 16.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page