===============================
Cell Maps Hierarchy Evaluation
===============================
.. image:: https://img.shields.io/pypi/v/cellmaps_hierarchyeval.svg
:target: https://pypi.python.org/pypi/cellmaps_hierarchyeval
.. image:: https://app.travis-ci.com/idekerlab/cellmaps_hierarchyeval.svg?branch=main
:target: https://app.travis-ci.com/idekerlab/cellmaps_hierarchyeval
.. image:: https://readthedocs.org/projects/cellmaps-hierarchyeval/badge/?version=latest
:target: https://cellmaps-hierarchyeval.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
evaluate hidef hierarchy
* Free software: MIT license
* Documentation: https://cellmaps-hierarchyeval.readthedocs.io.
Dependencies
------------
* `cellmaps_utils <https://pypi.org/project/cellmaps-utils>`__
* `statsmodels <https://pypi.org/project/statsmodels>`__
* `tqdm <https://pypi.org/project/tqdm>`__
* `scipy <https://pypi.org/project/scipy>`__
* `numpy <https://pypi.org/project/numpy>`__
* `ndex2 <https://pypi.org/project/ndex2>`__
Compatibility
-------------
* Python 3.8+
Installation
------------
.. code-block::
git clone https://github.com/idekerlab/cellmaps_hierarchyeval
cd cellmaps_hierarchyeval
make dist
pip install dist/cellmaps_hierarchyevalcmd*whl
Run **make** command with no arguments to see other build/deploy options including creation of Docker image
.. code-block::
make
Output:
.. code-block::
clean remove all build, test, coverage and Python artifacts
clean-build remove build artifacts
clean-pyc remove Python file artifacts
clean-test remove test and coverage artifacts
lint check style with flake8
test run tests quickly with the default Python
test-all run tests on every Python version with tox
coverage check code coverage quickly with the default Python
docs generate Sphinx HTML documentation, including API docs
servedocs compile the docs watching for changes
testrelease package and upload a TEST release
release package and upload a release
dist builds source and wheel package
install install the package to the active Python's site-packages
dockerbuild build docker image and store in local repository
dockerpush push image to dockerhub
Before running tests, please install: ``pip install -r requirements_dev.txt``.
For developers
-------------------------------------------
To deploy development versions of this package
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Below are steps to make changes to this code base, deploy, and then run
against those changes.
#. Make changes
Modify code in this repo as desired
#. Build and deploy
.. code-block::
# From base directory of this repo cellmaps_hierarchyeval
pip uninstall cellmaps_hierarchyeval -y ; make clean dist; pip install dist/cellmaps_hierarchy*whl
Needed files
------------
**TODO:** Add description of needed files
Usage
-----
For information invoke :code:`cellmaps_hierarchyevalcmd.py -h`
**Example usage**
**TODO:** Add information about example usage
.. code-block::
cellmaps_hierarchyevalcmd.py # TODO Add other needed arguments here
Via Docker
~~~~~~~~~~~~~~~~~~~~~~
**Example usage**
**TODO:** Add information about example usage
.. code-block::
Coming soon...
Credits
-------
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
.. _NDEx: http://www.ndexbio.org
=======
History
=======
0.1.0 (2024-09-09)
------------------
* First release on PyPI.
Raw data
{
"_id": null,
"home_page": "https://github.com/idekerlab/cellmaps_hierarchyeval",
"name": "cellmaps-hierarchyeval",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "cellmaps_hierarchyeval",
"author": "Cell Maps team",
"author_email": "tools@cm4ai.org",
"download_url": "https://files.pythonhosted.org/packages/e3/40/ae738357e3553f69d40758e84341e2cf23aaafef2b70ed23cf2b065fdfee/cellmaps_hierarchyeval-0.1.0.tar.gz",
"platform": null,
"description": "===============================\nCell Maps Hierarchy Evaluation\n===============================\n\n\n.. image:: https://img.shields.io/pypi/v/cellmaps_hierarchyeval.svg\n :target: https://pypi.python.org/pypi/cellmaps_hierarchyeval\n\n.. image:: https://app.travis-ci.com/idekerlab/cellmaps_hierarchyeval.svg?branch=main\n :target: https://app.travis-ci.com/idekerlab/cellmaps_hierarchyeval\n\n.. image:: https://readthedocs.org/projects/cellmaps-hierarchyeval/badge/?version=latest\n :target: https://cellmaps-hierarchyeval.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n\n\n\nevaluate hidef hierarchy\n\n\n* Free software: MIT license\n* Documentation: https://cellmaps-hierarchyeval.readthedocs.io.\n\nDependencies\n------------\n\n* `cellmaps_utils <https://pypi.org/project/cellmaps-utils>`__\n* `statsmodels <https://pypi.org/project/statsmodels>`__\n* `tqdm <https://pypi.org/project/tqdm>`__\n* `scipy <https://pypi.org/project/scipy>`__\n* `numpy <https://pypi.org/project/numpy>`__\n* `ndex2 <https://pypi.org/project/ndex2>`__\n\nCompatibility\n-------------\n\n* Python 3.8+\n\nInstallation\n------------\n\n.. code-block::\n\n git clone https://github.com/idekerlab/cellmaps_hierarchyeval\n cd cellmaps_hierarchyeval\n make dist\n pip install dist/cellmaps_hierarchyevalcmd*whl\n\n\nRun **make** command with no arguments to see other build/deploy options including creation of Docker image\n\n.. code-block::\n\n make\n\nOutput:\n\n.. code-block::\n\n clean remove all build, test, coverage and Python artifacts\n clean-build remove build artifacts\n clean-pyc remove Python file artifacts\n clean-test remove test and coverage artifacts\n lint check style with flake8\n test run tests quickly with the default Python\n test-all run tests on every Python version with tox\n coverage check code coverage quickly with the default Python\n docs generate Sphinx HTML documentation, including API docs\n servedocs compile the docs watching for changes\n testrelease package and upload a TEST release\n release package and upload a release\n dist builds source and wheel package\n install install the package to the active Python's site-packages\n dockerbuild build docker image and store in local repository\n dockerpush push image to dockerhub\n\nBefore running tests, please install: ``pip install -r requirements_dev.txt``.\n\nFor developers\n-------------------------------------------\n\nTo deploy development versions of this package\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nBelow are steps to make changes to this code base, deploy, and then run\nagainst those changes.\n\n#. Make changes\n\nModify code in this repo as desired\n\n#. Build and deploy\n\n.. code-block::\n\n # From base directory of this repo cellmaps_hierarchyeval\n pip uninstall cellmaps_hierarchyeval -y ; make clean dist; pip install dist/cellmaps_hierarchy*whl\n\n\n\nNeeded files\n------------\n\n**TODO:** Add description of needed files\n\n\nUsage\n-----\n\nFor information invoke :code:`cellmaps_hierarchyevalcmd.py -h`\n\n**Example usage**\n\n**TODO:** Add information about example usage\n\n.. code-block::\n\n cellmaps_hierarchyevalcmd.py # TODO Add other needed arguments here\n\n\nVia Docker\n~~~~~~~~~~~~~~~~~~~~~~\n\n**Example usage**\n\n**TODO:** Add information about example usage\n\n\n.. code-block::\n\n Coming soon...\n\nCredits\n-------\n\nThis package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n.. _NDEx: http://www.ndexbio.org\n\n\n=======\nHistory\n=======\n\n0.1.0 (2024-09-09)\n------------------\n\n* First release on PyPI.\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "A tool to evaluate hierarchies with known resources",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/idekerlab/cellmaps_hierarchyeval"
},
"split_keywords": [
"cellmaps_hierarchyeval"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9bb3a1df91258e3bc80443c6bc47bf2908ed47a63a2d72cef23728ff67543780",
"md5": "74234a5379016ad88715abcd893ebde3",
"sha256": "79d7f8c3098c71463f04b11368b2783754c823f03f88aecdb87f23f806810df3"
},
"downloads": -1,
"filename": "cellmaps_hierarchyeval-0.1.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "74234a5379016ad88715abcd893ebde3",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 28737,
"upload_time": "2024-09-09T18:56:45",
"upload_time_iso_8601": "2024-09-09T18:56:45.773328Z",
"url": "https://files.pythonhosted.org/packages/9b/b3/a1df91258e3bc80443c6bc47bf2908ed47a63a2d72cef23728ff67543780/cellmaps_hierarchyeval-0.1.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e340ae738357e3553f69d40758e84341e2cf23aaafef2b70ed23cf2b065fdfee",
"md5": "be0b9c375a129fa7022069b26199e5b5",
"sha256": "10f83dd8b6b22d8ea8d194dc8d2cdb1f1b50af76cf103686e768d6be07d3b78a"
},
"downloads": -1,
"filename": "cellmaps_hierarchyeval-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "be0b9c375a129fa7022069b26199e5b5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 314318,
"upload_time": "2024-09-09T18:56:47",
"upload_time_iso_8601": "2024-09-09T18:56:47.732768Z",
"url": "https://files.pythonhosted.org/packages/e3/40/ae738357e3553f69d40758e84341e2cf23aaafef2b70ed23cf2b065fdfee/cellmaps_hierarchyeval-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-09 18:56:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "idekerlab",
"github_project": "cellmaps_hierarchyeval",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"requirements": [],
"tox": true,
"lcname": "cellmaps-hierarchyeval"
}
JSON
