Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

EBR-115. Create 2 options for installing the library #56

Merged
merged 3 commits into from
Nov 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/build-python-wheel.yml
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ jobs:

- name: Build Extension in Dev Mode
run: |
pip install -e .
pip install -e .[full]

- name: Generate description files
run: |
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pypi-github-release-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ jobs:

- name: Build Extension in Dev Mode
run: |
pip install -e .
pip install -e .[full]

- name: Generate description files
run: |
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/run-python-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ jobs:

- name: Build Extension in Dev Mode
run: |
pip install -e .
pip install -e .[full]

- name: Run tests
run: |
Expand Down Expand Up @@ -92,7 +92,7 @@ jobs:

- name: Compute coverage
run: |
python -m pip install .[test]
python -m pip install .[full,test]
pytest -v --cov --cov-report=xml:coverage.xml tvbextxircuits

- name: SonarCloud Scan
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/run-ui-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ jobs:
run: python -m pip install --upgrade pip

- name: Build Extension in Dev Mode
run: pip install -e .
run: pip install -e .[full]

- name: Build Wheel
run: |
Expand Down
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,19 @@ This is a jupyterlab extension built as a prototype for building EBRAINS
extends the already existent [Xircuits](https://xircuits.io/) jupyterlab extension
by adding new components and new features on top.

For installing in a Jupyter Lab environment:
Starting with version 2.0.0, tvb-ext-xircuits can be installed in **lightweight** mode or in **full** mode.

**Full** mode means that the extension will be fully working and able to run workflows.

**Lightweight** mode means that only the front-end part of the extension will be available, meaning that the users will
be able to see all the extension's components, but running workflows will not work.

To install the extension locally and in full mode (recommended):

pip install tvb-ext-xircuits[full]


To install the extension in lightweight mode (only for specialized users):

pip install tvb-ext-xircuits

Expand All @@ -22,7 +34,7 @@ For dev mode setup there are 2 alternatives:
```
conda activate [my-env]
pip install --upgrade pip
pip install -e .
pip install -e .[full]
jupyter labextension develop . --overwrite # Link your development version of the extension with JupyterLab
jupyter server extension enable tvbextxircuits # Enable the server extension
tvbextxircuits
Expand All @@ -35,7 +47,7 @@ For dev mode setup there are 2 alternatives:
```
conda activate [my-env]
pip install --upgrade pip
pip install -e .
pip install -e .[full]
yarn install
yarn install:extension
tvbextxircuits
Expand Down
10 changes: 6 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,9 @@ dependencies = [
"jupyter-core",
"numpy<2",
"pyunicore",
"siibra",
"tvb-library",
"tvb-gdist",
"tvb-framework",
"tvb-ext-bucket",
"tvb-ext-unicore",
"tvb-widgets>=1.0",
"importlib_resources",
]
dynamic = ["description", "authors", "urls", "keywords"]
Expand All @@ -61,6 +57,12 @@ test = [
"pytest-cov",
"pytest-jupyter[server]>=0.6.0"
]
full = [
"siibra",
"tvb-gdist",
"tvb-framework",
"tvb-widgets>=1.0",
]


[tool.hatch.metadata.hooks.nodejs]
Expand Down