Name | sciunit JSON |
Version |
0.2.8
JSON |
| download |
home_page | http://sciunit.scidash.org |
Summary | A test-driven framework for formally validating scientific models against data. |
upload_time | 2024-01-03 17:24:37 |
maintainer | |
docs_url | None |
author | Rick Gerkin |
requires_python | >=3.7 |
license | MIT |
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/86/21/ecc7ba82b11caa47121d5bbd34a3e5f7ffe0337b1273ef37b292f0984ed6/sciunit-0.2.8.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",
"bugtrack_url": null,
"license": "MIT",
"summary": "A test-driven framework for formally validating scientific models against data.",
"version": "0.2.8",
"project_urls": {
"Homepage": "http://sciunit.scidash.org"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8621ecc7ba82b11caa47121d5bbd34a3e5f7ffe0337b1273ef37b292f0984ed6",
"md5": "319a9f9e02cb9b62f12f5c242b289a34",
"sha256": "85b7288200e55a3270d2346cc357c19d2c812140a9398eda52152a6cb5a281f5"
},
"downloads": -1,
"filename": "sciunit-0.2.8.tar.gz",
"has_sig": false,
"md5_digest": "319a9f9e02cb9b62f12f5c242b289a34",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 254714,
"upload_time": "2024-01-03T17:24:37",
"upload_time_iso_8601": "2024-01-03T17:24:37.215465Z",
"url": "https://files.pythonhosted.org/packages/86/21/ecc7ba82b11caa47121d5bbd34a3e5f7ffe0337b1273ef37b292f0984ed6/sciunit-0.2.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-03 17:24:37",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sciunit"
}