# tvb-ext-unicore
[](https://github.com/the-virtual-brain/tvb-ext-unicore/actions/workflows/build.yml) [](https://sonarcloud.io/summary/new_code?id=the-virtual-brain_tvb-ext-unicore) [](https://sonarcloud.io/summary/new_code?id=the-virtual-brain_tvb-ext-unicore)
[](https://sonarcloud.io/summary/new_code?id=the-virtual-brain_tvb-ext-unicore)
### TVB Widgets - A Unicore Lab extension
This jupyter extension offers a UI component to monitor HPC jobs through Unicore interface. It allows users
to easily switch between computing sites, retrieve details about the jobs,
and also cancel them.
The package is composed of a Python module named `tvbextunicore`
for the server extension and a NPM package named `tvb-ext-unicore`
for the frontend extension.
As the extension provides access to different EBRAINS HPC sites, it needs
your EBRAINS authentication token in order to work.
There are 2 options to use this extension:
1. Directly in [EBRAINS Lab](https://lab.ebrains.eu/): in this case, your token
will be retrieved automatically (as you had to login for accessing the extension).
2. Outside EBRAINS Lab: you will need to manually copy your authentication token from
EBRAINS Lab and keep it in an environment variable called **CLB_AUTH**.
## Requirements
* JupyterLab >= 3.0
* pyunicore >= 0.9.15
## Install
To install the extension, execute:
```bash
pip install tvb-ext-unicore
```
## Uninstall
To remove the extension, execute:
```bash
pip uninstall tvb-ext-unicore
```
## Troubleshoot
If you are seeing the frontend extension, but it is not working, check
that the server extension is enabled:
```bash
jupyter server extension list
```
If the server extension is installed and enabled, but you are not seeing
the frontend extension, check the frontend extension is installed:
```bash
jupyter labextension list
```
## Contributing
### Development install
Note: You will need NodeJS to build the extension package.
The `jlpm` command is JupyterLab's pinned version of
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` in lieu of `jlpm` below.
```bash
# Install external dependencies
pip install pyunicore
# Clone the tvb-ext-unicore repo to your local environment
# Change directory to the tvb-ext-unicore directory
cd tvb-ext-unicore
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Server extension must be manually installed in develop mode
jupyter server extension enable tvbextunicore
# Define CLB_AUTH environment variable holding your EBRAINS token
export CLB_AUTH=${ebrains_token}
# Rebuild extension Typescript source after making changes
jlpm run build
```
You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
```bash
# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab
```
With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
By default, the `jlpm run build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
```bash
jupyter lab build --minimize=False
```
### Development uninstall
```bash
# Server extension must be manually disabled in develop mode
jupyter server extension disable tvbextunicore
pip uninstall tvb-ext-unicore
```
In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
folder is located. Then you can remove the symlink named `tvb-ext-unicore` within that folder.
### Acknowledgments
This project has received funding from the European Union’s Horizon 2020 Framework Programme for Research and Innovation under the Specific Grant Agreement No. 945539 (Human Brain Project SGA3).
This project has received funding from the European Union’s Horizon Europe Programme under the Specific Grant Agreement No. 101147319 (EBRAINS 2.0 Project).
Raw data
{
"_id": null,
"home_page": "https://github.com/the-virtual-brain/tvb-ext-unicore",
"name": "tvb-ext-unicore",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "Jupyter, JupyterLab, JupyterLab3",
"author": "TVB Widgets Team",
"author_email": "tvb.admin@thevirtualbrain.org",
"download_url": "https://files.pythonhosted.org/packages/12/ad/3d12f8ca55ac51ac3aa57903f10d0ca685c6e6eb8499318fe8a4ee558bf2/tvb-ext-unicore-2.0.0.tar.gz",
"platform": "Linux",
"description": "# tvb-ext-unicore\n\n[](https://github.com/the-virtual-brain/tvb-ext-unicore/actions/workflows/build.yml) [](https://sonarcloud.io/summary/new_code?id=the-virtual-brain_tvb-ext-unicore) [](https://sonarcloud.io/summary/new_code?id=the-virtual-brain_tvb-ext-unicore)\n [](https://sonarcloud.io/summary/new_code?id=the-virtual-brain_tvb-ext-unicore)\n\n\n### TVB Widgets - A Unicore Lab extension\n\nThis jupyter extension offers a UI component to monitor HPC jobs through Unicore interface. It allows users \nto easily switch between computing sites, retrieve details about the jobs, \nand also cancel them.\n\nThe package is composed of a Python module named `tvbextunicore`\nfor the server extension and a NPM package named `tvb-ext-unicore`\nfor the frontend extension.\n\nAs the extension provides access to different EBRAINS HPC sites, it needs \nyour EBRAINS authentication token in order to work.\n\nThere are 2 options to use this extension:\n\n1. Directly in [EBRAINS Lab](https://lab.ebrains.eu/): in this case, your token \nwill be retrieved automatically (as you had to login for accessing the extension).\n2. Outside EBRAINS Lab: you will need to manually copy your authentication token from \nEBRAINS Lab and keep it in an environment variable called **CLB_AUTH**.\n\n## Requirements\n\n* JupyterLab >= 3.0\n* pyunicore >= 0.9.15\n\n## Install\n\nTo install the extension, execute:\n\n```bash\npip install tvb-ext-unicore\n```\n\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\npip uninstall tvb-ext-unicore\n```\n\n\n## Troubleshoot\n\nIf you are seeing the frontend extension, but it is not working, check\nthat the server extension is enabled:\n\n```bash\njupyter server extension list\n```\n\nIf the server extension is installed and enabled, but you are not seeing\nthe frontend extension, check the frontend extension is installed:\n\n```bash\njupyter labextension list\n```\n\n\n## Contributing\n\n### Development install\n\nNote: You will need NodeJS to build the extension package.\n\nThe `jlpm` command is JupyterLab's pinned version of\n[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use\n`yarn` or `npm` in lieu of `jlpm` below.\n\n```bash\n# Install external dependencies\npip install pyunicore\n\n# Clone the tvb-ext-unicore repo to your local environment\n# Change directory to the tvb-ext-unicore directory\ncd tvb-ext-unicore\n# Install package in development mode\npip install -e .\n# Link your development version of the extension with JupyterLab\njupyter labextension develop . --overwrite\n# Server extension must be manually installed in develop mode\njupyter server extension enable tvbextunicore\n\n# Define CLB_AUTH environment variable holding your EBRAINS token\nexport CLB_AUTH=${ebrains_token}\n\n# Rebuild extension Typescript source after making changes\njlpm run build\n```\n\nYou can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.\n\n```bash\n# Watch the source directory in one terminal, automatically rebuilding when needed\njlpm run watch\n# Run JupyterLab in another terminal\njupyter lab\n```\n\nWith the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).\n\nBy default, the `jlpm run build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:\n\n```bash\njupyter lab build --minimize=False\n```\n\n### Development uninstall\n\n```bash\n# Server extension must be manually disabled in develop mode\njupyter server extension disable tvbextunicore\npip uninstall tvb-ext-unicore\n```\n\nIn development mode, you will also need to remove the symlink created by `jupyter labextension develop`\ncommand. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`\nfolder is located. Then you can remove the symlink named `tvb-ext-unicore` within that folder.\n\n### Acknowledgments\n\nThis project has received funding from the European Union\u2019s Horizon 2020 Framework Programme for Research and Innovation under the Specific Grant Agreement No. 945539 (Human Brain Project SGA3).\n\nThis project has received funding from the European Union\u2019s Horizon Europe Programme under the Specific Grant Agreement No. 101147319 (EBRAINS 2.0 Project).\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "TVB Widgets - A Unicore Lab extension",
"version": "2.0.0",
"project_urls": {
"Homepage": "https://github.com/the-virtual-brain/tvb-ext-unicore"
},
"split_keywords": [
"jupyter",
" jupyterlab",
" jupyterlab3"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8eda2ce935ab4f964520d544352179929b57baf4234a37c4e2bf22fcdac1f400",
"md5": "865b63eb535923c0be7f133be8f7be16",
"sha256": "d9d77648a531e62660a616eb4cab2ac776345efc9ccc77e360711949f5ceda03"
},
"downloads": -1,
"filename": "tvb_ext_unicore-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "865b63eb535923c0be7f133be8f7be16",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 59727,
"upload_time": "2024-04-05T20:11:49",
"upload_time_iso_8601": "2024-04-05T20:11:49.505321Z",
"url": "https://files.pythonhosted.org/packages/8e/da/2ce935ab4f964520d544352179929b57baf4234a37c4e2bf22fcdac1f400/tvb_ext_unicore-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "12ad3d12f8ca55ac51ac3aa57903f10d0ca685c6e6eb8499318fe8a4ee558bf2",
"md5": "aea0a49d2374f575a764125c2903a882",
"sha256": "85c4176c4a833149245e41e2448e94e5507f44bb7c3ffe1e5cf52f9c9b76e7ad"
},
"downloads": -1,
"filename": "tvb-ext-unicore-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "aea0a49d2374f575a764125c2903a882",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 204279,
"upload_time": "2024-04-05T20:11:50",
"upload_time_iso_8601": "2024-04-05T20:11:50.837371Z",
"url": "https://files.pythonhosted.org/packages/12/ad/3d12f8ca55ac51ac3aa57903f10d0ca685c6e6eb8499318fe8a4ee558bf2/tvb-ext-unicore-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-05 20:11:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "the-virtual-brain",
"github_project": "tvb-ext-unicore",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tvb-ext-unicore"
}
JSON
