Skip to main content

iFISH-Probe-Design

DOI
PyPI - Python Version PyPI - Format PyPI - Status

PyPi | docs

iFISH-Probe-Design (ifpd) is a Python3.7+ package containing tools for selection of complementary oligonucleotides to build iFISH probes. It also includes a web interface, which simplifies the procedure by removing any requirement for programming skills. Read the online documentation for more details.

Requirements

iFISH-Probe-Designer is fully implemented in Python3.7+, thus you need Python3 to run it. Check out here how to install Python3.7+ on your machine if you don't have it yet.

ifpd has been tested with Python 3.7, 3.8, and 3.9. We recommend installing it using pipx (see below) to avoid dependency conflicts with other packages. The packages it depends on are listed in our dependency graph. We use poetry to handle our dependencies.

Installation

We recommend installing ifpd using pipx. Check how to install pipx here if you don't have it yet!

Once you have pipx ready on your system, install the latest stable release of ifpd by running: pipx install ifpd. If you see the stars (✨ 🌟 ✨), then the installation went well!

Usage

All iFISH-Probe-Design commands are accessible via the ifpd keyword on the terminal. For each command, you can access its help page by using the -h option. More details on how to run ifpd are available in the online documentation.

Contributing

We welcome any contributions to ifpd. In short, we use black to standardize code format. Any code change also needs to pass mypy checks. For more details, please refer to our contribution guidelines if this is your first time contributing! Also, check out our code of conduct.

Reference

  • Gelali, E., Girelli, G., Matsumoto, M., Wernersson, E., Custodio, J., Mota, A., ... & Bienko, M. (2019). iFISH is a publicly available resource enabling versatile DNA FISH to study genome architecture. Nature communications, 10(1), 1-15. (link)

License

MIT License - Copyright (c) 2016-21 Gabriele Girelli

Metadata

Release files for ifpd 2.1.1.post2

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

Source distribution (sdist)

Source distribution for ifpd 2.1.1.post2
File Size Uploaded
ifpd-2.1.1.post2.tar.gz 7.2 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for ifpd 2.1.1.post2
File Interpreter ABI Platform
ifpd-2.1.1.post2-py3-none-any.whl Python 3 none any Details

Total release size: 14.3 MB

Release files / ifpd-2.1.1.post2.tar.gz

Download URL ifpd-2.1.1.post2.tar.gz
Size 7.2 MB
Tags Source
SHA-256 checksum
How to use checksums
93c10cfb9daa280b065419cd1bf055421ea396dd84a4550a065d8c8fab9e2a66
BLAKE2b-256 checksum
How to use checksums
5922d5aecf2c0a5cfdab92bc07378391141b638641fcc54d6519d781ce0bfc39
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.5 CPython/3.8.10 Linux/5.4.0-90-generic

Release files / ifpd-2.1.1.post2-py3-none-any.whl

Download URL ifpd-2.1.1.post2-py3-none-any.whl
Size 7.2 MB
Tags Python 3
SHA-256 checksum
How to use checksums
9b3eb627ad0abc199543b3eee7a5ef338b722382752913f5bac1f2b1017cfe15
BLAKE2b-256 checksum
How to use checksums
2e957ccd919b7975630d174d2673e86c5be1309fc6a1821048fd535c9c601012
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.5 CPython/3.8.10 Linux/5.4.0-90-generic
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