# CosApp Lab - Toolbox for managing and deploying CoSApp powered dashboards.
[](https://cosapp-lab.readthedocs.io/en/latest/)
[](https://mybinder.org/v2/gl/cosapp%2Fcosapp_lab/master?urlpath=lab/tree/examples/SysExplorer.ipynb)
## Introduction
The primary goal of **CoSApp Lab** is to help users transform existing CoSApp
modules into interactive dashboards, with almost no additional development or
configuration.
### Examples
#### Using CosApp Lab in JupyterLab
CoSApp Lab provides a JupyterLab extension named **SysExplorer** for creating interactive dashboards. This extension allows users to dynamically customize the layout and fill their dashboard with multiple predefined widgets, such as charts, controllers (sliders, *etc.*), 3D visualization panels...
#### Using CosApp Lab standalone mode
Dashboards defined with **SysExplorer** in JupyterLab can also be exported into libraries and served by CoSApp Lab as web applications.
## Documentation
A more detailed **CoSApp Lab** documentation is available at:
https://cosapp-lab.readthedocs.io/
## Installation
### Stable release
The easiest way to obtain `cosapp_lab` is to install the conda package:
```shell
conda install -c conda-forge cosapp_lab
```
`cosapp_lab` is also available on PyPI. However, since `pythonocc-core` is not, users can install `cosapp_lab` with *pip*, but the 3D viewer widget will not work.
```shell
pip install cosapp-lab
```
`JupyterLab` is not a direct dependency of `cosapp_lab`, but users need to have JupyterLab (>3.0) in order to create CoSApp dashboard in notebooks.
### Development
#### Setup development environment
```shell
# create a new conda environment
conda create -n cosapplab -c conda-forge python jupyterlab nodejs
conda activate cosapplab
# download cosapp_lab from gitlab
git clone --recursive https://gitlab.com/cosapp/cosapp_lab.git
# install JS dependencies, build and install JupyterLab extension in development mode
cd cosapp_lab
jlpm install
jlpm build:all
jlpm install:extension
# install cosapp_lab in editable mode
python -m pip install -e .
```
#### Testing
```shell
# Test python code
python -m pytest
# Test typescript code
jlpm test
```
#### Build documents
```shell
cd docs
sphinx-build -b html -d _build/doctrees . _build
```
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/cosapp/cosapp_lab",
"name": "cosapp-lab",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Jupyter,Widgets,CoSApp",
"author": "CoSApp Development Team",
"author_email": "etienne.lac@safrangroup.com",
"download_url": "https://files.pythonhosted.org/packages/2d/19/1d5ec6cce85419cfea525091981a02658d6af5d395ca293a3deeee149b2f/cosapp_lab-0.16.0-1.tar.gz",
"platform": "Linux",
"description": "# CosApp Lab - Toolbox for managing and deploying CoSApp powered dashboards.\n\n\n[](https://cosapp-lab.readthedocs.io/en/latest/)\n[](https://mybinder.org/v2/gl/cosapp%2Fcosapp_lab/master?urlpath=lab/tree/examples/SysExplorer.ipynb)\n\n\n## Introduction\n\n\nThe primary goal of **CoSApp Lab** is to help users transform existing CoSApp \nmodules into interactive dashboards, with almost no additional development or\nconfiguration.\n\n\n### Examples\n\n\n\n#### Using CosApp Lab in JupyterLab\n\nCoSApp Lab provides a JupyterLab extension named **SysExplorer** for creating interactive dashboards. This extension allows users to dynamically customize the layout and fill their dashboard with multiple predefined widgets, such as charts, controllers (sliders, *etc.*), 3D visualization panels...\n\n\n\n\n\n#### Using CosApp Lab standalone mode\n\nDashboards defined with **SysExplorer** in JupyterLab can also be exported into libraries and served by CoSApp Lab as web applications. \n\n\n\n\n## Documentation\n\nA more detailed **CoSApp Lab** documentation is available at:\n\nhttps://cosapp-lab.readthedocs.io/\n \n\n\n## Installation\n\n\n### Stable release\n\n\nThe easiest way to obtain `cosapp_lab` is to install the conda package:\n\n```shell\nconda install -c conda-forge cosapp_lab\n``` \n\n`cosapp_lab` is also available on PyPI. However, since `pythonocc-core` is not, users can install `cosapp_lab` with *pip*, but the 3D viewer widget will not work.\n\n```shell\npip install cosapp-lab\n``` \n\n`JupyterLab` is not a direct dependency of `cosapp_lab`, but users need to have JupyterLab (>3.0) in order to create CoSApp dashboard in notebooks. \n\n### Development\n\n\n\n#### Setup development environment\n\n\n```shell\n # create a new conda environment\n conda create -n cosapplab -c conda-forge python jupyterlab nodejs\n conda activate cosapplab\n\n # download cosapp_lab from gitlab\n git clone --recursive https://gitlab.com/cosapp/cosapp_lab.git\n\n # install JS dependencies, build and install JupyterLab extension in development mode \n cd cosapp_lab\n jlpm install\n jlpm build:all\n jlpm install:extension\n\n # install cosapp_lab in editable mode\n python -m pip install -e .\n``` \n\n\n#### Testing\n\n```shell\n # Test python code\n python -m pytest\n\n # Test typescript code\n jlpm test\n``` \n\n\n\n#### Build documents\n\n\n```shell\ncd docs\nsphinx-build -b html -d _build/doctrees . _build\n``` \n\n\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Toolbox for managing and deploying CoSApp powered dashboards.",
"version": "0.16.0.post1",
"split_keywords": [
"jupyter",
"widgets",
"cosapp"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2d191d5ec6cce85419cfea525091981a02658d6af5d395ca293a3deeee149b2f",
"md5": "4b22335dc332dd82d394c8b11c6b6cd2",
"sha256": "da3c4e8279f7795a1930ebdd5ba36f7cdc6d27d2c06313faec643fd89048f744"
},
"downloads": -1,
"filename": "cosapp_lab-0.16.0-1.tar.gz",
"has_sig": false,
"md5_digest": "4b22335dc332dd82d394c8b11c6b6cd2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5311257,
"upload_time": "2023-03-14T08:38:00",
"upload_time_iso_8601": "2023-03-14T08:38:00.911512Z",
"url": "https://files.pythonhosted.org/packages/2d/19/1d5ec6cce85419cfea525091981a02658d6af5d395ca293a3deeee149b2f/cosapp_lab-0.16.0-1.tar.gz",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "11e2247b5a327703e0853a7e318c27c38a5d765ab8effb3b3271f46d6c4d85e5",
"md5": "5385d1e47d05484e211f552f6d19058b",
"sha256": "84c97cf4d0daa820baa3b1f9a5ae70b64c8e474d2eec2cd7b50fa732069cc6dc"
},
"downloads": -1,
"filename": "cosapp_lab-0.16.0.post1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5385d1e47d05484e211f552f6d19058b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7089850,
"upload_time": "2023-03-14T08:38:04",
"upload_time_iso_8601": "2023-03-14T08:38:04.383791Z",
"url": "https://files.pythonhosted.org/packages/11/e2/247b5a327703e0853a7e318c27c38a5d765ab8effb3b3271f46d6c4d85e5/cosapp_lab-0.16.0.post1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-14 08:38:00",
"github": false,
"gitlab": true,
"bitbucket": false,
"gitlab_user": "cosapp",
"gitlab_project": "cosapp_lab",
"lcname": "cosapp-lab"
}
JSON