ifpd2


Nameifpd2 JSON
Version 1.0.0a0 PyPI version JSON
download
home_pagehttps://github.com/ggirelli/iFISH-Probe-Design
SummaryAn iFISH probe design pipeline (II)
upload_time2021-02-26 08:35:50
maintainer
docs_urlNone
authorGabriele Girelli
requires_python>=3.7.1,<4.0.0
licenseMIT
keywords biology cell dna rna fish fluorescence hybridization
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # iFISH Probe Design (II)

![](https://img.shields.io/github/license/ggirelli/ifpd2.svg?style=flat)   ![](https://github.com/ggirelli/ifpd2/workflows/Python%20package/badge.svg?branch=main&event=push)  
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ifpd2) ![PyPI - Format](https://img.shields.io/pypi/format/ifpd2) ![PyPI - Status](https://img.shields.io/pypi/status/ifpd2)  
![](https://img.shields.io/github/release/ggirelli/ifpd2.svg?style=flat) ![](https://img.shields.io/github/release-date/ggirelli/ifpd2.svg?style=flat) ![](https://img.shields.io/github/languages/code-size/ggirelli/ifpd2.svg?style=flat)  
![](https://img.shields.io/github/watchers/ggirelli/ifpd2.svg?label=Watch&style=social) ![](https://img.shields.io/github/stars/ggirelli/ifpd2.svg?style=social)

[PyPi](https://pypi.org/project/ifpd2/) | [docs](https://ggirelli.github.io/ifpd2/)

`ifpd2` is a Python3.7+ 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.7+, 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.7 and 3.8. 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/ggirelli/iFISH-Probe-Design",
    "name": "ifpd2",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7.1,<4.0.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/a4/7d/13aa9e076387b97baffad0378f2a7ccb778290261aeeb706902ebe238996/ifpd2-1.0.0a0.tar.gz",
    "platform": "",
    "description": "# iFISH Probe Design (II)\n\n![](https://img.shields.io/github/license/ggirelli/ifpd2.svg?style=flat)   ![](https://github.com/ggirelli/ifpd2/workflows/Python%20package/badge.svg?branch=main&event=push)  \n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ifpd2) ![PyPI - Format](https://img.shields.io/pypi/format/ifpd2) ![PyPI - Status](https://img.shields.io/pypi/status/ifpd2)  \n![](https://img.shields.io/github/release/ggirelli/ifpd2.svg?style=flat) ![](https://img.shields.io/github/release-date/ggirelli/ifpd2.svg?style=flat) ![](https://img.shields.io/github/languages/code-size/ggirelli/ifpd2.svg?style=flat)  \n![](https://img.shields.io/github/watchers/ggirelli/ifpd2.svg?label=Watch&style=social) ![](https://img.shields.io/github/stars/ggirelli/ifpd2.svg?style=social)\n\n[PyPi](https://pypi.org/project/ifpd2/) | [docs](https://ggirelli.github.io/ifpd2/)\n\n`ifpd2` is a Python3.7+ 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.7+, 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.7 and 3.8. 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.0a0",
    "split_keywords": [
        "biology",
        "cell",
        "dna",
        "rna",
        "fish",
        "fluorescence",
        "hybridization"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "ad4c941d25373dada80b28b4a2d3d797",
                "sha256": "4f97df132cb0bf50c83970770727b1f12a3e614c974c7f1f7cdfe01901c69ce1"
            },
            "downloads": -1,
            "filename": "ifpd2-1.0.0a0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ad4c941d25373dada80b28b4a2d3d797",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7.1,<4.0.0",
            "size": 28767,
            "upload_time": "2021-02-26T08:35:48",
            "upload_time_iso_8601": "2021-02-26T08:35:48.819210Z",
            "url": "https://files.pythonhosted.org/packages/fc/9d/511dbc3e9630b52661c91bffed7706ab6ce36ef4e780bafe95aabadfd813/ifpd2-1.0.0a0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "f5d2ce278bf71951d84f7a59442488ce",
                "sha256": "105b195413461cf4a33dda857a581a5c7299ce81de1d9936a536aa3fce9173f8"
            },
            "downloads": -1,
            "filename": "ifpd2-1.0.0a0.tar.gz",
            "has_sig": false,
            "md5_digest": "f5d2ce278bf71951d84f7a59442488ce",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7.1,<4.0.0",
            "size": 23544,
            "upload_time": "2021-02-26T08:35:50",
            "upload_time_iso_8601": "2021-02-26T08:35:50.252644Z",
            "url": "https://files.pythonhosted.org/packages/a4/7d/13aa9e076387b97baffad0378f2a7ccb778290261aeeb706902ebe238996/ifpd2-1.0.0a0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-02-26 08:35:50",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "ggirelli",
    "error": "Could not fetch GitHub repository",
    "lcname": "ifpd2"
}
        
Elapsed time: 0.19052s