{ "info": { "author": "vittore.scolari@pasteur.fr", "author_email": "", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Science/Research", "License :: OSI Approved :: Artistic License", "Operating System :: MacOS", "Operating System :: Microsoft :: Windows", "Operating System :: POSIX", "Operating System :: Unix", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3 :: Only", "Topic :: Scientific/Engineering", "Topic :: Scientific/Engineering :: Bio-Informatics", "Topic :: Scientific/Engineering :: Visualization" ], "description": "![Serpentine logo](demos/serpentine.gif)\n\n# Serpentine binning\n\n[![PyPI version](https://badge.fury.io/py/serpentine.svg)](https://badge.fury.io/py/serpentine)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/serpentine.svg)\n[![Build Status](https://travis-ci.org/koszullab/serpentine.svg?branch=master)](https://travis-ci.org/koszullab/serpentine)\n[![Appveyor Status](https://ci.appveyor.com/api/projects/status/github/koszullab/serpentine?svg=true)](https://ci.appveyor.com/project/baudrly/serpentine)\n[![codecov](https://codecov.io/gh/koszullab/serpentine/branch/master/graph/badge.svg)](https://codecov.io/gh/koszullab/serpentine)\n[![Read the docs](https://readthedocs.org/projects/serpentine/badge)](https://serpentine.readthedocs.io)\n[![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/koszullab/serpentine/master?filepath=doc%2Fnotebooks%2Fdemo_yeast.ipynb)\n[![License: Artistic-2.0](https://img.shields.io/badge/License-Artistic%202.0-0298c3.svg)](https://opensource.org/licenses/Artistic-2.0)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)\n\nLocally smearing noisy regions in Hi-C contact maps as a prelude to differential analyses\n\n## Table of contents\n\n - [Synopsis](#synopsis)\n - [Installation](#installation)\n - [Documentation](#documentation)\n - [Authors](#authors)\n - [Copyright and license](#copyright-and-license)\n\n## Synopsis\n\nUse it as a Python 3 library:\n\n```python\n import numpy as np\n import serpentine as sp\n\n A = np.loadtxt('./demos/A.csv')\n B = np.loadtxt('./demos/B.csv')\n trend, threshold = sp.MDbefore(A, B, show=False)\n\n sA, sB, sK = sp.serpentin_binning(A, B, threshold, threshold / 5)\n```\n\nOr as a standalone UNIX tool:\n\n```\n$ serpentine --help\n Serpentine binning\n\n An implementation of the so-called 'serpentine binning' procedure described\n in Scolari et al.\n\n Command line::\n\n Usage:\n serpentine.py [] [] [--threshold=auto] [--verbose]\n [--min-threshold=auto] [--trend=high] [--triangular]\n [--limit=3] [--demo] [--demo-size=500]\n\n Arguments:\n matrixA The first input matrix, in plain text\n CSV format. Optional in demo mode.\n matrixB The second input matrix, in plain text\n CSV format. Optional in demo mode or\n single binning mode.\n\n Options:\n -h, --help Display this help message.\n --version Display the program's current version.\n -t auto, --threshold auto Threshold value to trigger binning.\n [default: auto]\n -m auto, --min-threshold auto Minimum value to force trigger binning\n in either matrix. [default: auto]\n --trend high Trend to subtract to the differential\n matrix, possible values are \"mean\":\n equal amount of positive and negative\n differences, and \"high\": normalize\n at the regions with higher coverage.\n [default: high]\n --triangular Treat the matrix as triangular,\n useful when plotting matrices adjacent\n to the diagonal. [default: False]\n --limit 3 Set the z-axis limit on the\n plot of the differential matrix.\n [default: 3]\n --demo Run a demo on randomly generated\n matrices. [default: False]\n --demo-size 500 Size of the test matrix for the demo.\n [default: 500]\n -v, --verbose Show verbose output. [default: False]\n```\n\n## Installation\n\n```sh\n sudo pip3 install -e git+https://github.com/koszullab/serpentine.git@master#egg=serpentine\n```\n\n## Documentation\n\nExecuting the command `serpentine --help` will give you a brief help of the command line tool. For a detailed reference to the python library functions, please \nread the [documentation](https://serpentine.readthedocs.io/en/latest/).\n\n## Authors\n\nCluster Buster ([scovit](https://github.com/scovit), a.k.a. Vittore F. Scolari),\nLyamovich ([baudrly](https://github.com/baudrly), a.k.a. Lyam Baudry)\n\n## Copyright and license\n\nCopyright \u00a9 2017 Institut Pasteur, this software has been developed in\nthe Regulation Spatiale des Chromosomes team of Pasteur Institut,\nParis, France.\n\nThis library is free software; you can redistribute it and/or modify\nit under the Artistic License.\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/koszullab/serpentine", "keywords": "", "license": "Artistic License 2.0", "maintainer": "", "maintainer_email": "", "name": "serpentine", "package_url": "https://pypi.org/project/serpentine/", "platform": "", "project_url": "https://pypi.org/project/serpentine/", "project_urls": { "Homepage": "https://github.com/koszullab/serpentine" }, "release_url": "https://pypi.org/project/serpentine/0.1.2/", "requires_dist": [ "numpy", "scipy", "docopt", "matplotlib", "pandas" ], "requires_python": ">=3.4", "summary": "Serpentine binning package for Hi-C contact maps", "version": "0.1.2" }, "last_serial": 4943111, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "d7c227b14c2881796dc18c9faf88fc42", "sha256": "0b2f0a8984fe832929e0391f41b9d0a7c127d1fd20c99e95c4c9a70e8a463916" }, "downloads": -1, "filename": "serpentine-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "d7c227b14c2881796dc18c9faf88fc42", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=3.4", "size": 14293, "upload_time": "2018-11-13T13:56:50", "url": "https://files.pythonhosted.org/packages/90/0f/39181c7cda6e259f830c0386752cc2a262e740ae69b077017abbd822540b/serpentine-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c1695a2c85594a24415e16c49ec9aa08", "sha256": "f0f26b528b00746ebdc97e5ed8765d58f5037d6ca9584d602b300179fae5b5f7" }, "downloads": -1, "filename": "serpentine-0.1.0.tar.gz", "has_sig": false, "md5_digest": "c1695a2c85594a24415e16c49ec9aa08", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.4", "size": 12731, "upload_time": "2018-11-13T13:56:52", "url": "https://files.pythonhosted.org/packages/b5/4e/fde096f7139c80aa43de9af72b4c46057ed814c8b81bf4d108d78203f521/serpentine-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "c52ad29f510cedf1a3e77b5429f97a9d", "sha256": "130b87c52002dbd0b91f24a84cfcd7d3f54c9ce3ab8b252caccefcea2024953a" }, "downloads": -1, "filename": "serpentine-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "c52ad29f510cedf1a3e77b5429f97a9d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.4", "size": 15887, "upload_time": "2018-12-11T16:37:26", "url": "https://files.pythonhosted.org/packages/09/45/d2bb778e84fe82700351a2d4b25b538a27187b24f76d511a10d9b3b6ed0d/serpentine-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "8632a97732ef54632c2cb47cd66d5590", "sha256": "406e9d65fe6579fb57740acfc539b1dfd0a3e9ac231786548db5ae1dd0014d2a" }, "downloads": -1, "filename": "serpentine-0.1.1.tar.gz", "has_sig": false, "md5_digest": "8632a97732ef54632c2cb47cd66d5590", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.4", "size": 13942, "upload_time": "2018-12-11T16:37:27", "url": "https://files.pythonhosted.org/packages/e3/78/b027c2b7dbac540e8b783f13122a57d418e47434fef519ca0e7850093740/serpentine-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "946bc993dd99dbca5f477739c9c58991", "sha256": "6612a6d52cf5bd4fb6259bab8678fb41f8bf6c449f4ee1428b04d73ab308b034" }, "downloads": -1, "filename": "serpentine-0.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "946bc993dd99dbca5f477739c9c58991", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.4", "size": 16792, "upload_time": "2019-03-15T08:14:25", "url": "https://files.pythonhosted.org/packages/39/f5/15da226c556a6e46eb6c0ff82591b5002d13832cfbbd028beaa0d4db1710/serpentine-0.1.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a2f325d8a8e09ddb10e2cf3237133350", "sha256": "804222930e9af53adff9e2ddcb143df929ff103bdb84609e14e3b15b43424321" }, "downloads": -1, "filename": "serpentine-0.1.2.tar.gz", "has_sig": false, "md5_digest": "a2f325d8a8e09ddb10e2cf3237133350", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.4", "size": 14950, "upload_time": "2019-03-15T08:14:27", "url": "https://files.pythonhosted.org/packages/ac/2f/eb3060f87835c068a516ea0a34361a6796091931a0cf7f3269c54e6c31f0/serpentine-0.1.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "946bc993dd99dbca5f477739c9c58991", "sha256": "6612a6d52cf5bd4fb6259bab8678fb41f8bf6c449f4ee1428b04d73ab308b034" }, "downloads": -1, "filename": "serpentine-0.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "946bc993dd99dbca5f477739c9c58991", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.4", "size": 16792, "upload_time": "2019-03-15T08:14:25", "url": "https://files.pythonhosted.org/packages/39/f5/15da226c556a6e46eb6c0ff82591b5002d13832cfbbd028beaa0d4db1710/serpentine-0.1.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a2f325d8a8e09ddb10e2cf3237133350", "sha256": "804222930e9af53adff9e2ddcb143df929ff103bdb84609e14e3b15b43424321" }, "downloads": -1, "filename": "serpentine-0.1.2.tar.gz", "has_sig": false, "md5_digest": "a2f325d8a8e09ddb10e2cf3237133350", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.4", "size": 14950, "upload_time": "2019-03-15T08:14:27", "url": "https://files.pythonhosted.org/packages/ac/2f/eb3060f87835c068a516ea0a34361a6796091931a0cf7f3269c54e6c31f0/serpentine-0.1.2.tar.gz" } ] }