# 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
npm run install
npm run build:all
npm run install:extension
# install cosapp_lab in editable mode
python -m pip install -e .
```
#### Testing
```shell
# Test python code
python -m pytest
# Test typescript code
npm run test
```
#### Build documents
```shell
cd docs
sphinx-build -b html -d _build/doctrees . _build
```
Raw data
{
"_id": null,
"home_page": null,
"name": "cosapp-lab",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "CoSApp Team <etienne.lac@safrangroup.com>",
"download_url": "https://files.pythonhosted.org/packages/3b/bc/ac9832338da903d5959523d258e2650c722846633ad7ade469cf291d465c/cosapp_lab-0.17.0.tar.gz",
"platform": null,
"description": "# CosApp Lab - Toolbox for managing and deploying CoSApp powered dashboards.\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## Introduction\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### Examples\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#### 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## Documentation\n\nA more detailed **CoSApp Lab** documentation is available at:\n\nhttps://cosapp-lab.readthedocs.io/\n\n## Installation\n\n### Stable release\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#### Setup development environment\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 npm run install\n npm run build:all\n npm run install:extension\n\n # install cosapp_lab in editable mode\n python -m pip install -e .\n```\n\n#### Testing\n\n```shell\n # Test python code\n python -m pytest\n\n # Test typescript code\n npm run test\n```\n\n#### Build documents\n\n```shell\ncd docs\nsphinx-build -b html -d _build/doctrees . _build\n```\n",
"bugtrack_url": null,
"license": "Copyright (C) 2017-2021 Safran SA - All Rights Reserved CoSApp Lab Open Source License: Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this software except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.",
"summary": "Toolbox for managing and deploying CoSApp powered dashboards.",
"version": "0.17.0",
"project_urls": {
"Bug Tracker": "https://gitlab.com/cosapp/cosapp_lab/issues",
"Homepage": "https://gitlab.com/cosapp/cosapp_lab",
"Repository": "https://gitlab.com/cosapp/cosapp_lab.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3ad741847f47068bf70132460919d23d34b686f527fd8fb8a7b2197f5511fcbc",
"md5": "3d53904f801091ae8b4afada7c38e254",
"sha256": "4005926685985801a372a168b1743b676c34fe94836c39a4d98a9a1368ac2ca3"
},
"downloads": -1,
"filename": "cosapp_lab-0.17.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3d53904f801091ae8b4afada7c38e254",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6127482,
"upload_time": "2024-07-19T12:08:13",
"upload_time_iso_8601": "2024-07-19T12:08:13.171017Z",
"url": "https://files.pythonhosted.org/packages/3a/d7/41847f47068bf70132460919d23d34b686f527fd8fb8a7b2197f5511fcbc/cosapp_lab-0.17.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3bbcac9832338da903d5959523d258e2650c722846633ad7ade469cf291d465c",
"md5": "cc391f8b56bc5a54df51251f9b639297",
"sha256": "7f92abfe0322f11551448b5182105252e0d1ce8937d489d07458edd493268e6e"
},
"downloads": -1,
"filename": "cosapp_lab-0.17.0.tar.gz",
"has_sig": false,
"md5_digest": "cc391f8b56bc5a54df51251f9b639297",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 23095804,
"upload_time": "2024-07-19T12:08:04",
"upload_time_iso_8601": "2024-07-19T12:08:04.655057Z",
"url": "https://files.pythonhosted.org/packages/3b/bc/ac9832338da903d5959523d258e2650c722846633ad7ade469cf291d465c/cosapp_lab-0.17.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-19 12:08:04",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "cosapp",
"gitlab_project": "cosapp_lab",
"lcname": "cosapp-lab"
}
JSON