Lab and Downward Lab
====================
**Lab** is a Python package for evaluating solvers on benchmark sets.
Experiments can run on a single machine or on a computer cluster. The
package also contains code for parsing results and creating reports.
The **Downward Lab** Python package facilitates running experiments for
the `Fast Downward <http://www.fast-downward.org>`_ planning system. It
uses the generic experimentation package **Lab**. Currently, Lab and
Downward Lab are distributed together.
**Code**: https://github.com/aibasel/lab
**Documentation**: https://lab.readthedocs.io
**Cite**: please cite Downward Lab by using
::
@Misc{seipp-et-al-zenodo2017,
author = "Jendrik Seipp and Florian Pommerening and
Silvan Sievers and Malte Helmert",
title = "{Downward} {Lab}",
publisher = "Zenodo",
year = "2017",
howpublished = "\url{https://doi.org/10.5281/zenodo.790461}"
}
Install Lab
-----------
Lab requires Python 3 and Linux (e.g., Ubuntu). We recommend installing
Lab in a `Python virtual environment
<https://docs.python.org/3/tutorial/venv.html>`_. This has the advantage
that there are no modifications to the system-wide configuration, and that
you can create multiple environments with different Lab versions (e.g.,
for different papers) without conflicts::
# Install required packages, including virtualenv.
sudo apt install python3 python3-venv
# Create a new directory for your experiments.
mkdir experiments-for-my-paper
cd experiments-for-my-paper
# If PYTHONPATH is set, unset it to obtain a clean environment.
unset PYTHONPATH
# Create and activate a Python virtual environment for Lab.
python3 -m venv --prompt my-paper .venv
source .venv/bin/activate
# Install Lab in the virtual environment.
pip install -U pip wheel
pip install lab # or preferably a specific version with lab==x.y
# Store installed packages and exact versions for reproducibility.
# Ignore pkg-resources package (https://github.com/pypa/pip/issues/4022).
pip freeze | grep -v "pkg-resources" > requirements.txt
Please note that before running an experiment script you need to
activate the virtual environment with::
source .venv/bin/activate
We recommend clearing the ``PYTHONPATH`` variable before activating the
virtual environment.
Raw data
{
"_id": null,
"home_page": "https://github.com/aibasel/lab",
"name": "lab",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "benchmarks cluster grid",
"author": "Jendrik Seipp",
"author_email": "jendrikseipp@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/10/26/d071c1ce095b0b13fa88f72e1cb4b0537cd9b92bff562d6051f156389b8e/lab-8.4.tar.gz",
"platform": null,
"description": "Lab and Downward Lab\n====================\n\n**Lab** is a Python package for evaluating solvers on benchmark sets.\nExperiments can run on a single machine or on a computer cluster. The\npackage also contains code for parsing results and creating reports.\n\nThe **Downward Lab** Python package facilitates running experiments for\nthe `Fast Downward <http://www.fast-downward.org>`_ planning system. It\nuses the generic experimentation package **Lab**. Currently, Lab and\nDownward Lab are distributed together.\n\n**Code**: https://github.com/aibasel/lab\n\n**Documentation**: https://lab.readthedocs.io\n\n**Cite**: please cite Downward Lab by using\n\n::\n\n @Misc{seipp-et-al-zenodo2017,\n author = \"Jendrik Seipp and Florian Pommerening and\n Silvan Sievers and Malte Helmert\",\n title = \"{Downward} {Lab}\",\n publisher = \"Zenodo\",\n year = \"2017\",\n howpublished = \"\\url{https://doi.org/10.5281/zenodo.790461}\"\n }\n\n\nInstall Lab\n-----------\n\nLab requires Python 3 and Linux (e.g., Ubuntu). We recommend installing\nLab in a `Python virtual environment\n<https://docs.python.org/3/tutorial/venv.html>`_. This has the advantage\nthat there are no modifications to the system-wide configuration, and that\nyou can create multiple environments with different Lab versions (e.g.,\nfor different papers) without conflicts::\n\n # Install required packages, including virtualenv.\n sudo apt install python3 python3-venv\n\n # Create a new directory for your experiments.\n mkdir experiments-for-my-paper\n cd experiments-for-my-paper\n\n # If PYTHONPATH is set, unset it to obtain a clean environment.\n unset PYTHONPATH\n\n # Create and activate a Python virtual environment for Lab.\n python3 -m venv --prompt my-paper .venv\n source .venv/bin/activate\n\n # Install Lab in the virtual environment.\n pip install -U pip wheel\n pip install lab # or preferably a specific version with lab==x.y\n\n # Store installed packages and exact versions for reproducibility.\n # Ignore pkg-resources package (https://github.com/pypa/pip/issues/4022).\n pip freeze | grep -v \"pkg-resources\" > requirements.txt\n\nPlease note that before running an experiment script you need to\nactivate the virtual environment with::\n\n source .venv/bin/activate\n\nWe recommend clearing the ``PYTHONPATH`` variable before activating the\nvirtual environment.\n",
"bugtrack_url": null,
"license": "GPL3+",
"summary": "Benchmark your code",
"version": "8.4",
"project_urls": {
"Homepage": "https://github.com/aibasel/lab"
},
"split_keywords": [
"benchmarks",
"cluster",
"grid"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e76966f0e3aedfc85ddaabba9c1d4a5b213e0052c9795ffa999c16cbb25f9e99",
"md5": "9fdcd322eb1bf29a8d9df682d8d2558e",
"sha256": "b82fe35938bd4db9f906c804bbb389e3419fc4c6128dfa8f9183cb6a374dd0ef"
},
"downloads": -1,
"filename": "lab-8.4-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "9fdcd322eb1bf29a8d9df682d8d2558e",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 98646,
"upload_time": "2025-02-11T13:16:46",
"upload_time_iso_8601": "2025-02-11T13:16:46.837179Z",
"url": "https://files.pythonhosted.org/packages/e7/69/66f0e3aedfc85ddaabba9c1d4a5b213e0052c9795ffa999c16cbb25f9e99/lab-8.4-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1026d071c1ce095b0b13fa88f72e1cb4b0537cd9b92bff562d6051f156389b8e",
"md5": "1a0bfeefa40a3540da9d03d65080da2b",
"sha256": "3aaacb5fbc2be78443031de7f7455bd6c4e018abc1d64766da698ea4d80cd40b"
},
"downloads": -1,
"filename": "lab-8.4.tar.gz",
"has_sig": false,
"md5_digest": "1a0bfeefa40a3540da9d03d65080da2b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 83924,
"upload_time": "2025-02-11T13:16:49",
"upload_time_iso_8601": "2025-02-11T13:16:49.052512Z",
"url": "https://files.pythonhosted.org/packages/10/26/d071c1ce095b0b13fa88f72e1cb4b0537cd9b92bff562d6051f156389b8e/lab-8.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-11 13:16:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aibasel",
"github_project": "lab",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "lab"
}
JSON
