Skip to main content

STED image simulator in Python

Project description

pySTED

Open In Colab

We have built a realistic STED simulation platform within the Python environment, namely pysted. pysted breaks down a STED acquisition into its main constituents: wavelength dependent focusing properties of the objective lens, fluorophore excitation and depletion, and fluorescence detection. Each step of the acquisition process corresponds to an independent component of the pipeline and is created with its own parameters that users can modify according to their experimental requirements. Generating a synthetic image with the pysted simulator requires the user to specify the positions of the emitters in the field of view (referred to as datamap) and to provide the characteristics of the fluorophore). The emission and photobleaching properties of the fluorophores that are implemented in pysted and inspired from previous theoretical and experimental models. As in a real experiment, the datamap is continuously being updated during the simulation process to realistically simulate point-scanning acquisition schemes.

In this repository, we provide a few datamaps that can be loaded using the provided tools. However, if the user wants to create their own datamaps, we also provide the code to generate their datamaps at this repository.

Installation

We recommend using a virtual environment in which to install pySTED. Anaconda facilitates the creation of a virtual environment on most operating system. For exemple, a virtual environment can be created using

conda create --name pysted python=3.10
conda activate pysted

Using pip

We do not provide a pypi installation package (yet). The user can however install pySTED using the url of the current repository

pip install pysted

From source

Clone the repository on your computer

git clone https://github.com/FLClab/pySTED.git

To install the necessary public libraries, run

python -m pip install -r pySTED/requirements.txt
python -m pip install -e pySTED

Note. Using the local install will require to compile the cython code that are required in pySTED.

Usage

We highly recommend to run the provided notebook to get some insight about how to use pySTED.

Notebook

A Google Colab jupyter notebook is provided to learn the basics of pysted.

Local

Once pysted is installed, running the example script should be possible.

python pySTED_tutorial.py

Citation

If you use any material from this repository please cite the following

@article{bilodeau2024development,
  title={Development of AI-assisted microscopy frameworks through realistic simulation in pySTED},
  author={Bilodeau, Anthony and Michaud-Gagnon, Albert and Chabbert, Julia and Turcotte, Benoit and Heine, J{\"o}rn and Durand, Audrey and Lavoie-Cardinal, Flavie},
  journal={bioRxiv},
  pages={2024--03},
  year={2024},
  publisher={Cold Spring Harbor Laboratory}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pysted-0.0.4.tar.gz (2.9 MB view details)

Uploaded Source

Built Distributions

pysted-0.0.4-cp312-cp312-win_amd64.whl (3.1 MB view details)

Uploaded CPython 3.12 Windows x86-64

pysted-0.0.4-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.4 MB view details)

Uploaded CPython 3.12 manylinux: glibc 2.17+ x86-64

pysted-0.0.4-cp312-cp312-macosx_11_0_arm64.whl (3.1 MB view details)

Uploaded CPython 3.12 macOS 11.0+ ARM64

pysted-0.0.4-cp312-cp312-macosx_10_9_x86_64.whl (3.1 MB view details)

Uploaded CPython 3.12 macOS 10.9+ x86-64

pysted-0.0.4-cp311-cp311-win_amd64.whl (3.1 MB view details)

Uploaded CPython 3.11 Windows x86-64

pysted-0.0.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.4 MB view details)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

pysted-0.0.4-cp311-cp311-macosx_11_0_arm64.whl (3.1 MB view details)

Uploaded CPython 3.11 macOS 11.0+ ARM64

pysted-0.0.4-cp311-cp311-macosx_10_9_x86_64.whl (3.1 MB view details)

Uploaded CPython 3.11 macOS 10.9+ x86-64

pysted-0.0.4-cp310-cp310-win_amd64.whl (3.1 MB view details)

Uploaded CPython 3.10 Windows x86-64

pysted-0.0.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.2 MB view details)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

pysted-0.0.4-cp310-cp310-macosx_11_0_arm64.whl (3.1 MB view details)

Uploaded CPython 3.10 macOS 11.0+ ARM64

pysted-0.0.4-cp310-cp310-macosx_10_9_x86_64.whl (3.1 MB view details)

Uploaded CPython 3.10 macOS 10.9+ x86-64

pysted-0.0.4-cp39-cp39-win_amd64.whl (3.1 MB view details)

Uploaded CPython 3.9 Windows x86-64

pysted-0.0.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.2 MB view details)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

pysted-0.0.4-cp39-cp39-macosx_11_0_arm64.whl (3.1 MB view details)

Uploaded CPython 3.9 macOS 11.0+ ARM64

pysted-0.0.4-cp39-cp39-macosx_10_9_x86_64.whl (3.1 MB view details)

Uploaded CPython 3.9 macOS 10.9+ x86-64

File details

Details for the file pysted-0.0.4.tar.gz.

File metadata

  • Download URL: pysted-0.0.4.tar.gz
  • Upload date:
  • Size: 2.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for pysted-0.0.4.tar.gz
Algorithm Hash digest
SHA256 57e930238d6783bf761154252a17b736f01dd07fea4b7b08dea6ac47733fb412
MD5 d6d73a7072adccbb2520e6d7622f5eea
BLAKE2b-256 ec1e45aaec10334c0961cc2cf2bbf48805e404573f5a74dd2b47087e445de51e

See more details on using hashes here.

File details

Details for the file pysted-0.0.4-cp312-cp312-win_amd64.whl.

File metadata

  • Download URL: pysted-0.0.4-cp312-cp312-win_amd64.whl
  • Upload date:
  • Size: 3.1 MB
  • Tags: CPython 3.12, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for pysted-0.0.4-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 307096703bd00de93903132466f62b1787d8481417843a0d27760dca4de632d3
MD5 6ead71c76dac61684308d42c79b3661e
BLAKE2b-256 1cdf9133947982c06578ff9ca9d48321f09824da15cafb2e8f022b6817658852

See more details on using hashes here.

File details

Details for the file pysted-0.0.4-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for pysted-0.0.4-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 69e9b86eeb85f7adc319f94d541b4445e97b5feca9a426dadad9716419825bd7
MD5 ee98c88ca9638e6f947d2ee29343f903
BLAKE2b-256 ed554f9c054fdda34c485cc3dcc53f58bd3ff8642f0ef0e3dc9d9cc89a024680

See more details on using hashes here.

File details

Details for the file pysted-0.0.4-cp312-cp312-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for pysted-0.0.4-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 544d577bf19f797a18c91a27f66699d4b55d25a601ba27c3bfc13c8a6a5d31ab
MD5 dae0aabd9069f5cd051baba544210103
BLAKE2b-256 5abab52de76271ef22f55a25ffbaeb165746d769387a76ca3a42193bcdf6ce2a

See more details on using hashes here.

File details

Details for the file pysted-0.0.4-cp312-cp312-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for pysted-0.0.4-cp312-cp312-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 e8adcaa4905492ee774401ef83609aedf4c84e6777bc7d97ffbe1b4577f0aec4
MD5 30c0746c5b13bc1e5be86d0ff9c80df7
BLAKE2b-256 0cab9951a9821bc1a66f06f5457190a44cecb421096a4442122265cddbfc86a0

See more details on using hashes here.

File details

Details for the file pysted-0.0.4-cp311-cp311-win_amd64.whl.

File metadata

  • Download URL: pysted-0.0.4-cp311-cp311-win_amd64.whl
  • Upload date:
  • Size: 3.1 MB
  • Tags: CPython 3.11, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for pysted-0.0.4-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 72904af561c330980fe71e14b63b6f10d54bf29c8e09d2498618f3950836736a
MD5 af61167d84c326db3e1e3a6f72a567b3
BLAKE2b-256 c5e43ea51fe98b92757f48c64ef0bfa7d807d6fadb455a4b2bd8825dbcb51719

See more details on using hashes here.

File details

Details for the file pysted-0.0.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for pysted-0.0.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 e0cee2106e9d58ab89a1fa38bb25c0fd490fd3f32aba16587c57897d1012eaea
MD5 a0c171324e5f729015bda5d0207390d2
BLAKE2b-256 67745555b378e93a2c72c27a234d9395d50c55df5348bd9b7099f1a55282f8d2

See more details on using hashes here.

File details

Details for the file pysted-0.0.4-cp311-cp311-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for pysted-0.0.4-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 17e9de03038b96bf3a44a4bccb00ba5ccf9fdb77435d0585cc85e6755d45c23a
MD5 b761a8fb0d8a1ce71b72aacab7378c4c
BLAKE2b-256 7d39d317ddb080c7a30d2065658ab8b442960934adaab5f3b549b52cb351086e

See more details on using hashes here.

File details

Details for the file pysted-0.0.4-cp311-cp311-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for pysted-0.0.4-cp311-cp311-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 d396d8c3097e9a6fba4072757cf3e41046f7e082310184e67585463091a2c472
MD5 c31767d4cb6b32730f5766b37fe5a66b
BLAKE2b-256 b5b850943c17a453f3c4fdb3a527fa8bd7aa4888f89e091a398e6675fb283d6d

See more details on using hashes here.

File details

Details for the file pysted-0.0.4-cp310-cp310-win_amd64.whl.

File metadata

  • Download URL: pysted-0.0.4-cp310-cp310-win_amd64.whl
  • Upload date:
  • Size: 3.1 MB
  • Tags: CPython 3.10, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for pysted-0.0.4-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 5c6c7fd3e8a3a08b65767ac3b2718db5e90441261a57a3b449398591e69b9105
MD5 de22a301f381784a861dc5b441f6c780
BLAKE2b-256 22c4cee765f4e260bd6e817f0ac350d859b2e748ecba77051f712d61b4999e5e

See more details on using hashes here.

File details

Details for the file pysted-0.0.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for pysted-0.0.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 3edad831e118b14c4d650b646538ec79f9d818a99d373faf8942706b5508b086
MD5 d867e1b7e307032be58415f718b3c2e4
BLAKE2b-256 36aa27482c1a944deb9ae22a35da3f767dfec67a59726c6fbb125c72dce2ccbc

See more details on using hashes here.

File details

Details for the file pysted-0.0.4-cp310-cp310-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for pysted-0.0.4-cp310-cp310-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 f9cfb8e69bf0c9915165eb65335d86b3b8a38332ca5b56d32cf65999b061410a
MD5 39e78129e6341248c9553964167eeb9a
BLAKE2b-256 6ed057e96809376910185a4da2002b95f729e3747189c076d8e30156665d8a69

See more details on using hashes here.

File details

Details for the file pysted-0.0.4-cp310-cp310-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for pysted-0.0.4-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 bb04b4cdaaf0df61a0b5749887f2490762d865b7c0b369d010999db73abc437e
MD5 ece98d7b3b355a9e13421f43a490f22b
BLAKE2b-256 0c585935094da4cfb2db4e232af54071ddce0297f8a15c84dd3b57504d8be7a4

See more details on using hashes here.

File details

Details for the file pysted-0.0.4-cp39-cp39-win_amd64.whl.

File metadata

  • Download URL: pysted-0.0.4-cp39-cp39-win_amd64.whl
  • Upload date:
  • Size: 3.1 MB
  • Tags: CPython 3.9, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for pysted-0.0.4-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 34076a08d9a3eccede1e97a7ccf7b3abd85539840b4d06fca08c458b372b8266
MD5 69086b35f41617aeebaab2dc02d9bd3e
BLAKE2b-256 b48f12891f6c9c94e4c132227b84732844e585c025ff96f8771c3ee028d68967

See more details on using hashes here.

File details

Details for the file pysted-0.0.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for pysted-0.0.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 520e190ce581c7557a85049e1367bf8773c3b0f0e68534a668825e67f1ab0be2
MD5 7aacc605238bce436571056fe4da250c
BLAKE2b-256 52a95e6bee8035c3afb405fdd84774709e837161a223ddc9c0906797ad06b6a7

See more details on using hashes here.

File details

Details for the file pysted-0.0.4-cp39-cp39-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for pysted-0.0.4-cp39-cp39-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 655e798b70b0b240de48266b1e1d6fd76339b0ddd591bc95f93223247bf81d5e
MD5 380af7614ec378d54fa8e5f3a18f6e45
BLAKE2b-256 3e0945f6887d81683125e4b65ca17f317e8fdee3207c6545fa08f8e607f8da90

See more details on using hashes here.

File details

Details for the file pysted-0.0.4-cp39-cp39-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for pysted-0.0.4-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 0b59dbd5aee43454af3ba83b8ff11815abc67a7be86fb0ce336271d6a94a48bf
MD5 04a9d1a03dc4f8c849db9644f298dec2
BLAKE2b-256 d82af88b29b8cc4bc477e8b67969b84642aa0fb7d8f69c752848d870015c3b5f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page