Skip to content

Commit

Permalink
WID-6 Update package description in README.md and copyright phrase in…
Browse files Browse the repository at this point in the history
… LICENSE
  • Loading branch information
liadomide committed Jan 31, 2022
1 parent 0b9e41a commit d5a17bc
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 1 deletion.
15 changes: 15 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
"TheVirtualBrain - Widgets" is a package with GUI components for EBRAINS

(c) 2022-2023, TVB Widgets Team

This program is free software: you can redistribute it and/or modify it under the terms
of the GNU General Public License as published by the Free Software Foundation, either
version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License (GPl_LICENSE.TXT from bellow) for more details.

-----------------

GPL_LICENSE.TXT
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007

Expand Down
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,23 @@
# tvb-widgets
Widgets for EBRAINS notebooks

**TheVirtualBrain - Widgets** is a package with somehow generic GUI components,
but developed for **EBRAINS Showcases** in particular.

The showcases developed in the last phase of the HBP are meant to illustrate
the full potential of technical and scientific features offered by EBRAINS.
Access by the end users to this showcased functionality should be as easy as
possible. In order to support the usability of the showcases, as well as future
EBRAINS workflows, we develop here a set of modular graphic solutions which
can be easily deployed in the EBRAINS Collaboratory within the JupyterLab.

These graphic user interface components enable:
1. Easy setup of models and region specific or cohort simulations. This includes single simulations as well as parameter explorations.
2. Selection of Data sources and their links to models. This will exploit the backend data access functionality to be developed new in TVB.
3. Previews of queried data from Siibra and the KG.
4. Deployment of jobs to HPC resources.
5. Integration of a subset of TVB analysis and visualisation tools.
6. The GUIs must be designed to be integrated into cells in the notebooks and Jupyter notebook extension for HPC resource usage and job tracking will be also developed as independent panels.

Installation:

pip install tvb-widgets

0 comments on commit d5a17bc

Please sign in to comment.