-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2ca7809
commit 4cd1865
Showing
1 changed file
with
32 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,30 +1,41 @@ | ||
| # 2024-team-5-service-4: fetch-scaffold-from-sparc-portal | ||
| # 2024-team-5- Service 4: Fetch Scaffold From SPARC Portal | ||
|
|
||
| Module to help fetch scaffold vtk file from SPARC Portal | ||
|    [](https://doi.org/10.5281/zenodo.13308937) | ||
|
|
||
| ## Usage | ||
| This module is part of: | ||
| <br/><br/> | ||
| <a href="https://github.com/SPARC-FAIR-Codeathon/2024-team-5"> | ||
| <image src="https://github.com/appukuttan-shailesh/testData/blob/master/SPARC2024/oSPARCHub_logo.png?raw=true" height="200px" /></a> | ||
| <br/><br/> | ||
|
|
||
| ```console | ||
| $ make help | ||
| This oSPARC service can fetch scaffold .vtk file from SPARC Portal for specified datasets. | ||
|
|
||
| $ make build | ||
| $ make info-build | ||
| $ make tests | ||
| ## Team #5 Repo | ||
|
|
||
| The team's main repo is located at: | ||
| https://github.com/SPARC-FAIR-Codeathon/2024-team-5 | ||
|
|
||
| ## Base Package | ||
|
|
||
| This oSPARC service was creating using [cookiecutter-osparc-service]( | ||
| https://github.com/ITISFoundation/cookiecutter-osparc-service). | ||
|
|
||
|
|
||
| ## Deployment Status | ||
|
|
||
| This service is awaiting deployment to oSPARC production. The GitHub actions fail, as we do not have the required permissions for the `build` stage: | ||
|
|
||
| > /home/scu/.venv/bin/python3: can't open file '/home/scu/.venv/bin/ooil': [Errno 13] Permission denied | ||
| Service has been deployed and tested locally via: | ||
| ``` | ||
| make publish-local | ||
| ``` | ||
|
|
||
| ## Citation | ||
|
|
||
| ## Workflow | ||
| Appukuttan, S., Benaribi, H., & Rievers, F. (2024). oSPARC Service #4: Fetch Scaffold From SPARC Portal. Zenodo. https://doi.org/10.5281/zenodo.13308937 | ||
|
|
||
| 1. The source code shall be copied to the [src](fetch-scaffold-from-sparc-portal/src/fetch_scaffold_from_sparc_portal) folder. | ||
| 2. The [Dockerfile](fetch-scaffold-from-sparc-portal/src/Dockerfile) shall be modified to compile the source code. | ||
| 3. The [.osparc](.osparc) is the configuration folder and source of truth for metadata: describes service info and expected inputs/outputs of the service. | ||
| 4. The [execute](fetch-scaffold-from-sparc-portal/service.cli/execute) shell script shall be modified to run the service using the expected inputs and retrieve the expected outputs. | ||
| 5. The test input/output shall be copied to [validation](fetch-scaffold-from-sparc-portal/validation). | ||
| 6. The service docker image may be built and tested as ``make build tests`` (see usage above) | ||
| 7. Optional: if your code requires specific CPU/RAM resources, edit [runtime.yml](.osparc/runtime.yml). In doubt, leave it as default. | ||
|
|
||
| ## Have an issue or question? | ||
| Please open an issue [in this repository](https://github.com/ITISFoundation/cookiecutter-osparc-service/issues/). | ||
| --- | ||
| <p align="center"> | ||
| <image src="https://github.com/ITISFoundation/osparc-simcore-python-client/blob/4e8b18494f3191d55f6692a6a605818aeeb83f95/docs/_media/mwl.png" alt="Made with love at www.z43.swiss" width="20%" /> | ||
| </p> | ||
| Please open an issue [here](https://github.com/SPARC-FAIR-Codeathon/2024-team-5-service-4/issues). |