-
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
2e652e1
commit eb1f6ca
Showing
1 changed file
with
39 additions
and
41 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,43 +1,41 @@ | ||
| # 2024-team-5-service-3: visualize-3d-model | ||
|
|
||
| Module to allow quick and simple visualization of 3D models | ||
|
|
||
| ## Requirements | ||
| - GNU Make | ||
| - Python3 | ||
| - [``Docker``](https://docs.docker.com/get-docker/) (if you wish to build and test the service locally) | ||
|
|
||
| ## Workflow | ||
| ### Create the Service | ||
| 1. Add your additional libraries to the appropriate in file [`env-config`](./env-config/) | ||
| 2. The [Dockerfile](visualize-3d-model/src/Dockerfile) shall be modified to install additional packages, software and/or Jupyter kernels (if something is need in addition to 1.) | ||
| 3. Optional: the [.osparc](.osparc) is the configuration folder and source of truth for metadata: describes service info and expected inputs/outputs of the service. If you need to change the inputs/outputs of the service, description, thumbnail, etc... check the [`metadata.yml`](./.osparc/metadata.yml) file | ||
| 4. Optional: if you need to change the start-up behavior of the service, modify the [`boot_notebook.bash`](./boot_scripts/boot_notebook.bash) file | ||
| 5. Optional (for testing): The service docker image may be built with ``make build`` (see "Useful Commands" below) | ||
| 6. Optional (for testing): The service docker image may be run locally with ``make run-local`` (see "Useful Commands" below) | ||
|
|
||
| ### Publish the Service on o²S²PARC | ||
| Once you're happy with your code: | ||
| 1. Push it to a public repository. | ||
| 2. An automated pipeline (GitHub Actions) will build the Docker image for you (as in step 5) | ||
| 3. Wait for the GitHub pipeline to run successfully | ||
| 4. Check that the automated pipeline executes successfully | ||
| 5. Once the pipeline has run successfully, get in touch with [o²S²PARC Support](mailto:[email protected]), we will take care of the final steps! | ||
|
|
||
| ### Change the Service (after it has been published on o²S²PARC ) | ||
| If you wish to change your Service (e.g. add additional librarie), after it has been published on o²S²PARC, you have to **create a new version**: | ||
| 1. Go back to your repository | ||
| 2. Apply the desired changes | ||
| 3. Increase ("bump") the Service version: in your console execute: ``make version-patch``, or ``make version-minor``, or ``make version-major`` | ||
| 4. Commit and push the changes to your repository | ||
| 5. Wait for the GitHub/GitLab pipelines to run successfully | ||
| 5. Once the pipeline has run successfully, get in touch with [o²S²PARC Support](mailto:[email protected]), we will take care of publishing the new version! | ||
|
|
||
|
|
||
| ### Useful commands | ||
| ```console | ||
| $ make help | ||
| $ make build # This will build an o²S²PARC-compatible image (similar to `Docker build` command) | ||
| $ make run-local # This will run the JupyterLab interface on your computer. Follow the instructions in your console to open it in your browser (useful e.g. to test that your code runs as expected) | ||
| # 2024-team-5- Service 3: Visualize 3D Model | ||
|
|
||
|    [](https://doi.org/10.5281/zenodo.13308931) | ||
|
|
||
| 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/> | ||
|
|
||
| This oSPARC service offers a quick and simple visualization of 3D scaffold models. | ||
|
|
||
| ## 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 | ||
|
|
||
| Appukuttan, S., Benaribi, H., & Rievers, F. (2024). oSPARC Service #3: Visualize 3D Model. Zenodo. https://doi.org/10.5281/zenodo.13308931 | ||
|
|
||
|
|
||
| ## Have an issue or question? | ||
| Please open an issue [here](https://github.com/SPARC-FAIR-Codeathon/2024-team-5-service-3/issues). |