sciunit


Namesciunit JSON
Version 0.2.7 PyPI version JSON
download
home_pagehttp://sciunit.scidash.org
SummaryA test-driven framework for formally validating scientific models against data.
upload_time2022-05-14 17:45:44
maintainer
docs_urlNone
authorRick Gerkin
requires_python>=3.7
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![Python package](https://github.com/scidash/sciunit/actions/workflows/python-package.yml/badge.svg)](https://github.com/scidash/sciunit/actions/workflows/python-package.yml)
[![RTFD](https://readthedocs.org/projects/sciunit/badge/?version=master&x=1)](http://sciunit.readthedocs.io/en/latest/?badge=master)
[![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/scidash/sciunit/master?filepath=docs%2Fchapter1.ipynb)
[![Coveralls](https://coveralls.io/repos/github/scidash/sciunit/badge.svg?branch=master&x=1)](https://coveralls.io/github/scidash/sciunit?branch=master)
[![Repos using Sciunit](https://img.shields.io/librariesio/dependent-repos/pypi/sciunit.svg?x=3)](https://github.com/scidash/sciunit/network/dependents?dependent_type=REPOSITORY)
![Downloads from PyPI](https://img.shields.io/pypi/dm/sciunit?x=1)

<img src="https://raw.githubusercontent.com/scidash/assets/master/logos/SciUnit/sci-unit-square-small.png" alt="SciUnit Logo" width="400px">

# SciUnit: A Test-Driven Framework for Formally Validating Scientific Models Against Data

## Concept
[The conference paper](https://github.com/cyrus-/papers/raw/master/sciunit-icse14/sciunit-icse14.pdf)

## Documentation
[![Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/scidash/sciunit/blob/master/docs/chapter1.ipynb) <br>
[Jupyter Tutorials](https://scidash.org/sciunit/README.html)<br>
[API Documentation](http://sciunit.rtfd.io)

## Installation
```python
pip install sciunit
```
or
```python
conda install -c conda-forge sciunit
```

## Basic Usage
```python
my_model = MyModel(**my_args) # Instantiate a class that wraps your model of interest.  
my_test = MyTest(**my_params) # Instantiate a test that you write.  
score = my_test.judge() # Runs the test and return a rich score containing test results and more.  
```

## Domain-specific libraries and information
[NeuronUnit](https://github.com/scidash/neuronunit) for neuron and ion channel physiology<br>
See others [here](https://github.com/scidash/sciunit/network/dependents?dependent_type=REPOSITORY)

## Mailing List
There is a [mailing list](https://groups.google.com/forum/?fromgroups#!forum/sciunit) for announcements and discussion.
Please join it if you are at all interested!

## Contributors
 * [Rick Gerkin](http://rick.gerk.in), Arizona State University (School of Life Science)
 * [Cyrus Omar](http://cs.cmu.edu/~comar), Carnegie Mellon University (Dept. of Computer Science)

## Reproducible Research ID
RRID:[SCR_014528](https://scicrunch.org/resources/Any/record/nlx_144509-1/3faed1d9-6579-5da6-b4b4-75a5077656bb/search?q=sciunit&l=sciunit)

## License
SciUnit is released under the permissive [MIT license](https://opensource.org/licenses/MIT), requiring only attribution in derivative works. See the LICENSE file for terms.



            

Raw data

            {
    "_id": null,
    "home_page": "http://sciunit.scidash.org",
    "name": "sciunit",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "",
    "author": "Rick Gerkin",
    "author_email": "rgerkin@asu.edu",
    "download_url": "https://files.pythonhosted.org/packages/85/6c/0344925ccb20cbf96949c3493c924c4e9a012ba0a8395fa80ab218264666/sciunit-0.2.7.tar.gz",
    "platform": null,
    "description": "[![Python package](https://github.com/scidash/sciunit/actions/workflows/python-package.yml/badge.svg)](https://github.com/scidash/sciunit/actions/workflows/python-package.yml)\n[![RTFD](https://readthedocs.org/projects/sciunit/badge/?version=master&x=1)](http://sciunit.readthedocs.io/en/latest/?badge=master)\n[![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/scidash/sciunit/master?filepath=docs%2Fchapter1.ipynb)\n[![Coveralls](https://coveralls.io/repos/github/scidash/sciunit/badge.svg?branch=master&x=1)](https://coveralls.io/github/scidash/sciunit?branch=master)\n[![Repos using Sciunit](https://img.shields.io/librariesio/dependent-repos/pypi/sciunit.svg?x=3)](https://github.com/scidash/sciunit/network/dependents?dependent_type=REPOSITORY)\n![Downloads from PyPI](https://img.shields.io/pypi/dm/sciunit?x=1)\n\n<img src=\"https://raw.githubusercontent.com/scidash/assets/master/logos/SciUnit/sci-unit-square-small.png\" alt=\"SciUnit Logo\" width=\"400px\">\n\n# SciUnit: A Test-Driven Framework for Formally Validating Scientific Models Against Data\n\n## Concept\n[The conference paper](https://github.com/cyrus-/papers/raw/master/sciunit-icse14/sciunit-icse14.pdf)\n\n## Documentation\n[![Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/scidash/sciunit/blob/master/docs/chapter1.ipynb) <br>\n[Jupyter Tutorials](https://scidash.org/sciunit/README.html)<br>\n[API Documentation](http://sciunit.rtfd.io)\n\n## Installation\n```python\npip install sciunit\n```\nor\n```python\nconda install -c conda-forge sciunit\n```\n\n## Basic Usage\n```python\nmy_model = MyModel(**my_args) # Instantiate a class that wraps your model of interest.  \nmy_test = MyTest(**my_params) # Instantiate a test that you write.  \nscore = my_test.judge() # Runs the test and return a rich score containing test results and more.  \n```\n\n## Domain-specific libraries and information\n[NeuronUnit](https://github.com/scidash/neuronunit) for neuron and ion channel physiology<br>\nSee others [here](https://github.com/scidash/sciunit/network/dependents?dependent_type=REPOSITORY)\n\n## Mailing List\nThere is a [mailing list](https://groups.google.com/forum/?fromgroups#!forum/sciunit) for announcements and discussion.\nPlease join it if you are at all interested!\n\n## Contributors\n * [Rick Gerkin](http://rick.gerk.in), Arizona State University (School of Life Science)\n * [Cyrus Omar](http://cs.cmu.edu/~comar), Carnegie Mellon University (Dept. of Computer Science)\n\n## Reproducible Research ID\nRRID:[SCR_014528](https://scicrunch.org/resources/Any/record/nlx_144509-1/3faed1d9-6579-5da6-b4b4-75a5077656bb/search?q=sciunit&l=sciunit)\n\n## License\nSciUnit is released under the permissive [MIT license](https://opensource.org/licenses/MIT), requiring only attribution in derivative works. See the LICENSE file for terms.\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A test-driven framework for formally validating scientific models against data.",
    "version": "0.2.7",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "0d48115cccbe1fac5ecd1bc56e59e79c",
                "sha256": "8f382262b50c622986d598a49cd86b2834ff45c44f31129deecffa7df2cf54d4"
            },
            "downloads": -1,
            "filename": "sciunit-0.2.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0d48115cccbe1fac5ecd1bc56e59e79c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 80557,
            "upload_time": "2022-05-14T17:45:43",
            "upload_time_iso_8601": "2022-05-14T17:45:43.164416Z",
            "url": "https://files.pythonhosted.org/packages/e5/12/9a3ce6a25677a36ece9947db86aa138f4f3eed8b28d0525dcf7fff8a2e5f/sciunit-0.2.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "0b7f91c45558e2f7fb7b9f6c4388a335",
                "sha256": "a6f6895999f47c0b2532abda98434df179a747216e906a748f9fe7620d3473a3"
            },
            "downloads": -1,
            "filename": "sciunit-0.2.7.tar.gz",
            "has_sig": false,
            "md5_digest": "0b7f91c45558e2f7fb7b9f6c4388a335",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 67458,
            "upload_time": "2022-05-14T17:45:44",
            "upload_time_iso_8601": "2022-05-14T17:45:44.806775Z",
            "url": "https://files.pythonhosted.org/packages/85/6c/0344925ccb20cbf96949c3493c924c4e9a012ba0a8395fa80ab218264666/sciunit-0.2.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-05-14 17:45:44",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "sciunit"
}
        
Elapsed time: 0.34348s