Skip to content

Commit

Permalink
Merge pull request #1 from ITISFoundation/first_version
Browse files Browse the repository at this point in the history
First version of voila-viewer service
  • Loading branch information
elisabettai authored Aug 4, 2023
2 parents 0e1f1c4 + daec0ad commit 8d362af
Show file tree
Hide file tree
Showing 21 changed files with 785 additions and 0 deletions.
17 changes: 17 additions & 0 deletions .bumpversion.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
[bumpversion]
current_version = 2.0.9
commit = False
message = service version: {current_version} → {new_version}
tag = False

[bumpversion:file:.osparc/jupyter-math/metadata.yml]
search = {current_version}
replace = {new_version}

[bumpversion:file:Makefile]
search = {current_version}
replace = {new_version}

[bumpversion:file:docker-compose-local.yml]
search = {current_version}
replace = {new_version}
9 changes: 9 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@

# Maps code in repository with maintainers
# Order is important. The last matching pattern has the most precedence.
# SEE https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/about-code-owners#example-of-a-codeowners-file

* @elisabettai

# NOTE: '/' denotes the root of the repository
/src/templates/index.html @GitHK
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/ask_question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: 💬 Question
about: Ask a question
labels: question
assignees: elisabettai
---

## What version of this service are you using?

<!--
Check in osparc UI:
- Search for 'math' under SERVICES
- Open the info dialog
- Copy& paste here the service KEY and VERSION. e.g. simcore/services/dynamic/jupyter-math 2.0.8
-->

## How can we help you?
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
name: 🐛 Bug
about: File a bug/issue
labels: bug
assignees: elisabettai
---

## What version of this service are you using?

<!--
Check in osparc UI:
- Search for 'math' under SERVICES
- Open the info dialog
- Copy& paste here the service KEY and VERSION. e.g. simcore/services/dynamic/jupyter-math 2.0.8
-->

## Long story short

<!-- Please describe your problem and why the fix is important. -->

## Expected behaviour

<!-- What is the behaviour you expect? -->

## Actual behaviour

<!-- What's actually happening? -->

## Steps to reproduce

<!-- Please describe steps to reproduce the issue.
If you have a script that does that please include it here within
markdown code markup -->

## Your environment

<!-- Describe the environment you have that lead to your issue.
This includes aiohttp version, OS, proxy server and other bits that
are related to your case.
IMPORTANT: aiohttp is both server framework and client library.
For getting rid of confusing please put 'server', 'client' or 'both'
word here.
-->
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: ✨ Feature request
about: Suggest an idea to implement
labels: enhancement
assignees: elisabettai
---

## User Story

<!-- A clear and concise description of how the feature works and looks like from the user's perspective.
Ex. I want to be able the stop the running pipeline by pressing a stop button. If the pipeline is stopped, I see a info-level message confirming it in the logger, if it fails the message should be displayed in red (error). Also, all the progress bars in the nodes must be set to 0. -->

## Example

<!-- Any file/screenshot/photomontage/video/website is provided for a better understanding of the request -->


## Definition of Done
<!--
A clear and concise description of what the feature requires.
1. Play button turns into stop button when pipeline is running
2. Stop button turns into play button when pipeline is finished
3. Stop button turns into play button when pipeline is successfully stopped
4. Logger displays messages everytime the play/stop button is pressed
5. Progress bars are set to 0 when stopping pipeline
6. Stop button has a Python interface -->
22 changes: 22 additions & 0 deletions .github/workflows/check-image.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Build and check image

on: push

jobs:
verify-image-build:
runs-on: ubuntu-latest
steps:
- name: Checkout repo content
uses: actions/checkout@v2
- name: ooil version
uses: docker://itisfoundation/ci-service-integration-library:v1.0.1-dev-43
with:
args: ooil --version
- name: Assemble docker-compose spec
uses: docker://itisfoundation/ci-service-integration-library:v1.0.1-dev-43
with:
args: ooil compose
- name: Build all images if multiple
uses: docker://itisfoundation/ci-service-integration-library:v1.0.1-dev-43
with:
args: docker-compose build
56 changes: 56 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Prerequisites
*.d

# Compiled Object files
*.slo
*.lo
*.o
*.obj

# Precompiled Headers
*.gch
*.pch

# Compiled Dynamic libraries
*.so
*.dylib
*.dll

# Build folders
build/
deploy/

# test folders
test/

# .env files
.env

# Python
__pycache__/
.venv/
.pytest_cache/

# java
*.class

# vscode
.vscode/

# docker
.env
# temp folders
tmp/
.tmp
# gitlab
*.toml

.cache/

# not interested in storing this file
docker-compose.yml

# ignore all files in validation
validation/

*.ignore.*
4 changes: 4 additions & 0 deletions .osparc/voila-viewer/docker-compose.overwrite.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
services:
voila-viewer:
build:
dockerfile: Dockerfile
163 changes: 163 additions & 0 deletions .osparc/voila-viewer/metadata.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
name: Voilà Viewer
thumbnail: https://github.com/voila-dashboards/voila/raw/main/docs/source/voila-logo.svg
description:
"Takes as input a Jupyter Notebook and it shows it using Jupyter [Voilà](https://github.com/voila-dashboards/voila)"
key: simcore/services/dynamic/voila-viewer
version: 1.0.0
integration-version: 2.0.0
type: dynamic
authors:
- name: Elisabetta Iavarone
email: [email protected]
affiliation: IT'IS Foundation
contact: [email protected]
inputs:
input_1:
displayOrder: 1.0
label: input_files_1
description:
Any input files. One or several files compressed in a zip will be
downloaded in an inputs folder.
type: data:*/*
fileToKeyMap:
"voila.ipynb": input_1
input_2:
displayOrder: 2.0
label: input_files_2
description:
Any input files. One or several files compressed in a zip will be
downloaded in an inputs folder.
type: data:*/*
input_3:
displayOrder: 3.0
label: input_files_3
description:
Any input files. One or several files compressed in a zip will be
downloaded in an inputs folder.
type: data:*/*
input_4:
displayOrder: 4.0
label: input_files_4
description:
Any input files. One or several files compressed in a zip will be
downloaded in an inputs folder.
type: data:*/*
input_5:
displayOrder: 5.0
label: input_files_5
description:
Any input files. One or several files compressed in a zip will be
downloaded in an inputs folder.
type: data:*/*
input_6:
displayOrder: 6.0
label: input_files_6
description:
Any input files. One or several files compressed in a zip will be
downloaded in an inputs folder.
type: data:*/*
input_7:
displayOrder: 7.0
label: input_files_7
description:
Any input files. One or several files compressed in a zip will be
downloaded in an inputs folder.
type: data:*/*
input_8:
displayOrder: 8.0
label: input_files_8
description:
Any input files. One or several files compressed in a zip will be
downloaded in an inputs folder.
type: data:*/*
input_9:
displayOrder: 9.0
label: input_files_9
description:
Any input files. One or several files compressed in a zip will be
downloaded in an inputs folder.
type: data:*/*
input_10:
displayOrder: 10.0
label: input_files_10
description:
Any input files. One or several files compressed in a zip will be
downloaded in an inputs folder.
type: data:*/*
input_11:
displayOrder: 11.0
label: input_files_11
description:
Any input files. One or several files compressed in a zip will be
downloaded in an inputs folder.
type: data:*/*
input_12:
displayOrder: 12.0
label: input_files_12
description:
Any input files. One or several files compressed in a zip will be
downloaded in an inputs folder.
type: data:*/*
input_13:
displayOrder: 13.0
label: input_files_13
description:
Any input files. One or several files compressed in a zip will be
downloaded in an inputs folder.
type: data:*/*
input_14:
displayOrder: 14.0
label: input_files_14
description:
Any input files. One or several files compressed in a zip will be
downloaded in an inputs folder.
type: data:*/*
input_15:
displayOrder: 15.0
label: input_files_15
description:
Any input files. One or several files compressed in a zip will be
downloaded in an inputs folder.
type: data:*/*
input_16:
displayOrder: 16.0
label: input_files_16
description:
Any input files. One or several files compressed in a zip will be
downloaded in an inputs folder.
type: data:*/*
input_17:
displayOrder: 17.0
label: input_files_17
description:
Any input files. One or several files compressed in a zip will be
downloaded in an inputs folder.
type: data:*/*
input_18:
displayOrder: 18.0
label: input_files_18
description:
Any input files. One or several files compressed in a zip will be
downloaded in an inputs folder.
type: data:*/*
input_19:
displayOrder: 19.0
label: input_files_19
description:
Any input files. One or several files compressed in a zip will be
downloaded in an inputs folder.
type: data:*/*
input_20:
displayOrder: 20.0
label: input_files_20
description:
Any input files. One or several files compressed in a zip will be
downloaded in an inputs folder.
type: data:*/*
outputs:
output_1:
displayOrder: 1.0
label: Output files 1
description: Output files uploaded from the outputs folder
type: data:*/*
min-visible-inputs: 2
20 changes: 20 additions & 0 deletions .osparc/voila-viewer/runtime.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
restart-policy: no-restart
settings:
- name: ports
type: int
value: 8888
- name: constraints
type: string
value:
- node.platform.os == linux
- name: Resources
type: Resources
value:
Limits:
NanoCPUs: 4000000000
MemoryBytes: 17179869184
paths-mapping:
inputs_path: /home/jovyan/work/inputs
outputs_path: /home/jovyan/work/outputs
state_paths:
- /home/jovyan/work/workspace
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Changelog

## [1.0.0] - 2023-08-04
- First version for testing in master


Loading

0 comments on commit 8d362af

Please sign in to comment.