# iFISH Probe Design (II)
**Zafer's fork from Quentin's fork from Gabriele's implementation**
[](https://zenodo.org/badge/latestdoi/210782569)  
  
  
 
[PyPi](https://pypi.org/project/ifpd2/) | [docs](https://ggirelli.github.io/ifpd2/)
`ifpd2` is a Python3.8+ package containing tools for selection of complementary oligonucleotides to build iFISH probes. It is based on our previous `ifpd` package, but works with a different and more detailed database format, allowing for more precise control on the probe design process. Read the online [documentation](https://ggirelli.github.io/ifpd2/) for more details.
## Requirements
`ifpd2` is fully implemented in Python3.8+, thus you need the corresponding Python version to run it. Check out [here](https://realpython.com/installing-python/) how to install Python+ on your machine if you don't have it yet.
`ifpd2` has been tested with Python 3.8 and 3.9. We recommend installing it using `pipx` (see [below](https://github.com/ggirelli/ifpd2#installation)) to avoid dependency conflicts with other packages. The packages it depends on are listed in our [dependency graph](https://github.com/ggirelli/ifpd2/network/dependencies). We use [`poetry`](https://github.com/python-poetry/poetry) to handle our dependencies.
## Installation
We recommend installing `ifpd2` using [`pipx`](https://github.com/pipxproject/pipx). Check how to install `pipx` [here](https://github.com/pipxproject/pipx#install-pipx) if you don't have it yet!
Once you have `pipx` ready on your system, install the latest stable release of `ifpd2` by running: `pipx install ifpd2`. If you see the stars (✨ 🌟 ✨), then the installation went well!
## Usage
All `ifpd2` commands are accessible via the `ifpd2` keyword on the terminal. For each command, you can access its help page by using the `-h` option. More details on how to run `ifpd2` are available in the online [documentation](https://ggirelli.github.io/ifpd2).
## Contributing
We welcome any contributions to `ifpd2`. In short, we use [`black`](https://github.com/psf/black) to standardize code format. Any code change also needs to pass `mypy` checks. For more details, please refer to our [contribution guidelines](https://github.com/ggirelli/ifpd2/blob/main/CONTRIBUTING.md) if this is your first time contributing! Also, check out our [code of conduct](https://github.com/ggirelli/ifpd2/blob/main/CODE_OF_CONDUCT.md).
## License
`MIT License - Copyright (c) 2021 Gabriele Girelli`
Raw data
{
"_id": null,
"home_page": "https://github.com/BiCro-HT/ifpd2_new",
"name": "ifpd2q",
"maintainer": "Quentin Verron",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "biology,cell,DNA,RNA,FISH,fluorescence,hybridization",
"author": "Gabriele Girelli",
"author_email": "gigi.ga90@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/bb/ae/d51d5253dfa5600eb9e23e86480909c5242e1c90c8f48fb88010e134219e/ifpd2q-1.0.4.tar.gz",
"platform": null,
"description": "# iFISH Probe Design (II)\n\n**Zafer's fork from Quentin's fork from Gabriele's implementation**\n\n[](https://zenodo.org/badge/latestdoi/210782569)   \n   \n   \n \n\n[PyPi](https://pypi.org/project/ifpd2/) | [docs](https://ggirelli.github.io/ifpd2/)\n\n`ifpd2` is a Python3.8+ package containing tools for selection of complementary oligonucleotides to build iFISH probes. It is based on our previous `ifpd` package, but works with a different and more detailed database format, allowing for more precise control on the probe design process. Read the online [documentation](https://ggirelli.github.io/ifpd2/) for more details.\n\n## Requirements\n\n`ifpd2` is fully implemented in Python3.8+, thus you need the corresponding Python version to run it. Check out [here](https://realpython.com/installing-python/) how to install Python+ on your machine if you don't have it yet.\n\n`ifpd2` has been tested with Python 3.8 and 3.9. We recommend installing it using `pipx` (see [below](https://github.com/ggirelli/ifpd2#installation)) to avoid dependency conflicts with other packages. The packages it depends on are listed in our [dependency graph](https://github.com/ggirelli/ifpd2/network/dependencies). We use [`poetry`](https://github.com/python-poetry/poetry) to handle our dependencies.\n\n## Installation\n\nWe recommend installing `ifpd2` using [`pipx`](https://github.com/pipxproject/pipx). Check how to install `pipx` [here](https://github.com/pipxproject/pipx#install-pipx) if you don't have it yet!\n\nOnce you have `pipx` ready on your system, install the latest stable release of `ifpd2` by running: `pipx install ifpd2`. If you see the stars (\u2728 \ud83c\udf1f \u2728), then the installation went well!\n\n## Usage\n\nAll `ifpd2` commands are accessible via the `ifpd2` keyword on the terminal. For each command, you can access its help page by using the `-h` option. More details on how to run `ifpd2` are available in the online [documentation](https://ggirelli.github.io/ifpd2).\n\n## Contributing\n\nWe welcome any contributions to `ifpd2`. In short, we use [`black`](https://github.com/psf/black) to standardize code format. Any code change also needs to pass `mypy` checks. For more details, please refer to our [contribution guidelines](https://github.com/ggirelli/ifpd2/blob/main/CONTRIBUTING.md) if this is your first time contributing! Also, check out our [code of conduct](https://github.com/ggirelli/ifpd2/blob/main/CODE_OF_CONDUCT.md).\n\n## License\n\n`MIT License - Copyright (c) 2021 Gabriele Girelli`\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An iFISH probe design pipeline (II)",
"version": "1.0.4",
"project_urls": {
"Homepage": "https://github.com/BiCro-HT/ifpd2_new",
"Repository": "https://github.com/BiCro-HT/ifpd2_new"
},
"split_keywords": [
"biology",
"cell",
"dna",
"rna",
"fish",
"fluorescence",
"hybridization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f169c6cd9de8181d237d2cc78768822c56b133b7028fee4fa9a7d3b05a25696f",
"md5": "3546a9ceb53f678faf82d948c9ec1c16",
"sha256": "b165c1a3f1edf35a37e8a97f692e3f4475e449dbece8c5968302f9ee215a40cb"
},
"downloads": -1,
"filename": "ifpd2q-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3546a9ceb53f678faf82d948c9ec1c16",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 51825,
"upload_time": "2024-02-29T17:20:15",
"upload_time_iso_8601": "2024-02-29T17:20:15.515930Z",
"url": "https://files.pythonhosted.org/packages/f1/69/c6cd9de8181d237d2cc78768822c56b133b7028fee4fa9a7d3b05a25696f/ifpd2q-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bbaed51d5253dfa5600eb9e23e86480909c5242e1c90c8f48fb88010e134219e",
"md5": "2a59022e0bb2c426dc78be1eab94e759",
"sha256": "b196d0a4aeb49db8e612f7d3f9aadac3e67cc681f37790b83a586bda4b00065f"
},
"downloads": -1,
"filename": "ifpd2q-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "2a59022e0bb2c426dc78be1eab94e759",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 159882,
"upload_time": "2024-02-29T17:20:17",
"upload_time_iso_8601": "2024-02-29T17:20:17.287563Z",
"url": "https://files.pythonhosted.org/packages/bb/ae/d51d5253dfa5600eb9e23e86480909c5242e1c90c8f48fb88010e134219e/ifpd2q-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-29 17:20:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "BiCro-HT",
"github_project": "ifpd2_new",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "ifpd2q"
}
JSON
