# Experiment Notebook (`enb`)
The `enb` Python (>= 3.7) library is a table-based framework designed to define, run and report computer-based
experiments.
- Your can create and run any type of (computer-based) experiment. Quickly.
- You can analyze and plot results produced with your enb experiments. Clearly. You can also reuse previously existing
data (e.g., in CSV format).
- You can easily create reproducible, redistributable software to be shared with others, e.g., as supplementary
materials in your publication or project.
- It runs on Linux, Windows and MacOS, in parallel. You can use clusters of Linux or MacOS computers.
## Quick start
The latest stable version of `enb` is available via pip, e.g.,
pip install enb
You can use this library in your python scripts by adding:
import enb
Several project demos and templates for your experiments are provided with enb. For a list of documentation templates,
you can run:
enb plugin list documentation
For example, you can try the distributed (although not really accurate)
[pi approximation project](https://github.com/miguelinux314/experiment-notebook/blob/dev/enb/plugins/template_montecarlo_pi/montecarlo_pi_experiment.py):
enb plugin install montecarlo-pi ./mp
./mp/montecarlo_pi_experiment.py
Or check out the most basic working examples with
the [basic workflow example](https://github.com/miguelinux314/experiment-notebook/blob/dev/enb/plugins/template_basic_workflow_example/basic_workflow.py)
enb plugin install basic-workflow ./bw
./bw/basic_workflow.py
## Resources
- A tutorial-like **user manual** is available at https://miguelinux314.github.io/experiment-notebook.
- You can browse
the [detailed installation instructions](https://miguelinux314.github.io/experiment-notebook/installation.html).
- A [gallery of plots](https://miguelinux314.github.io/experiment-notebook/analyzing_data.html)
produced (semi-)automatically produced from enb experiment results and from external CSV files is also available.
- Please refer to the [changelog](https://github.com/miguelinux314/experiment-notebook/blob/master/CHANGELOG.md)
for the main differences between consecutive `enb` versions.
Raw data
{
"_id": null,
"home_page": "https://github.com/miguelinux314/experiment-notebook",
"name": "enb",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Miguel Hern\u00e1ndez Cabronero, et al.",
"author_email": "miguel.hernandez@uab.cat",
"download_url": "https://files.pythonhosted.org/packages/af/e1/bf9aa5f79d2b062ddeeed472768ef1fc9ea6e8f24ac467a14b32e1fdacd1/enb-1.0.4.tar.gz",
"platform": "any",
"description": "# Experiment Notebook (`enb`)\n\nThe `enb` Python (>= 3.7) library is a table-based framework designed to define, run and report computer-based\nexperiments.\n\n- Your can create and run any type of (computer-based) experiment. Quickly.\n- You can analyze and plot results produced with your enb experiments. Clearly. You can also reuse previously existing\n data (e.g., in CSV format).\n- You can easily create reproducible, redistributable software to be shared with others, e.g., as supplementary\n materials in your publication or project.\n- It runs on Linux, Windows and MacOS, in parallel. You can use clusters of Linux or MacOS computers.\n\n## Quick start\n\nThe latest stable version of `enb` is available via pip, e.g.,\n\n pip install enb\n\nYou can use this library in your python scripts by adding:\n\n import enb\n\nSeveral project demos and templates for your experiments are provided with enb. For a list of documentation templates,\nyou can run:\n\n enb plugin list documentation\n\nFor example, you can try the distributed (although not really accurate)\n[pi approximation project](https://github.com/miguelinux314/experiment-notebook/blob/dev/enb/plugins/template_montecarlo_pi/montecarlo_pi_experiment.py):\n\n enb plugin install montecarlo-pi ./mp\n ./mp/montecarlo_pi_experiment.py\n\nOr check out the most basic working examples with\nthe [basic workflow example](https://github.com/miguelinux314/experiment-notebook/blob/dev/enb/plugins/template_basic_workflow_example/basic_workflow.py)\n\n enb plugin install basic-workflow ./bw\n ./bw/basic_workflow.py\n\n## Resources\n\n- A tutorial-like **user manual** is available at https://miguelinux314.github.io/experiment-notebook.\n\n- You can browse\n the [detailed installation instructions](https://miguelinux314.github.io/experiment-notebook/installation.html).\n\n- A [gallery of plots](https://miguelinux314.github.io/experiment-notebook/analyzing_data.html)\n produced (semi-)automatically produced from enb experiment results and from external CSV files is also available.\n\n- Please refer to the [changelog](https://github.com/miguelinux314/experiment-notebook/blob/master/CHANGELOG.md)\n for the main differences between consecutive `enb` versions.\n\n\n \n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Experiment NoteBook (enb): efficient and reproducible science.",
"version": "1.0.4",
"project_urls": {
"Download": "https://github.com/miguelinux314/experiment-notebook/archive/v1.0.4.tar.gz",
"Homepage": "https://github.com/miguelinux314/experiment-notebook"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3b2f055664cdc314f72c287d489cb3c65790ae7b3d61a444cb8bf85572bb512e",
"md5": "73213ab68b62a5d57639d62001d702fe",
"sha256": "2ef5386d7d737ea97fa58cf9c9f5785c4852299fa8804fd83dfd0bbfa574aaf2"
},
"downloads": -1,
"filename": "enb-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "73213ab68b62a5d57639d62001d702fe",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 1802206,
"upload_time": "2024-09-07T10:00:23",
"upload_time_iso_8601": "2024-09-07T10:00:23.165073Z",
"url": "https://files.pythonhosted.org/packages/3b/2f/055664cdc314f72c287d489cb3c65790ae7b3d61a444cb8bf85572bb512e/enb-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "afe1bf9aa5f79d2b062ddeeed472768ef1fc9ea6e8f24ac467a14b32e1fdacd1",
"md5": "aec16ad0037ff1d191b3a21bc114eb7c",
"sha256": "ea7057249c89b76c7fba64058ddfa6bace9e456e0869384e853ad6725e4ecf71"
},
"downloads": -1,
"filename": "enb-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "aec16ad0037ff1d191b3a21bc114eb7c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 1719229,
"upload_time": "2024-09-07T10:00:25",
"upload_time_iso_8601": "2024-09-07T10:00:25.413704Z",
"url": "https://files.pythonhosted.org/packages/af/e1/bf9aa5f79d2b062ddeeed472768ef1fc9ea6e8f24ac467a14b32e1fdacd1/enb-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-07 10:00:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "miguelinux314",
"github_project": "experiment-notebook",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "enb"
}
JSON
