Skip to content

Commit

Permalink
Adding missing cookiecuteer file
Browse files Browse the repository at this point in the history
  • Loading branch information
elisabettai committed Apr 15, 2024
1 parent 670e188 commit 08ec8a4
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Template library to generate an [o²S²PARC compatible interactive service with the JupyterLab environment](https://docs.osparc.io/#/docs/study_setup/JupyterLabs?id=jupyterlab).
In addition to the different JupyterLab "flavours" offered on o²S²PARC, you can use this library to create one with your favourite software and tools.

This library is pre-configured to easily build JuptyerLabs with Python, R or Julia and additional dependencies. Just choose the appropriate `base_image` when running the cookiecutter and follow the instructions in the `README.md`.
This library is pre-configured to easily build JupyterLabs with Python, R or Julia and additional dependencies. Just choose the appropriate `base_image` when running the cookiecutter and follow the instructions in the `README.md`.

If you need to install other custom software, you can do so my selecting the custom image as `base_image`.

Expand All @@ -12,7 +12,7 @@ If you need to install other custom software, you can do so my selecting the cus
- Python3
- Python3-venv (recommended to work in a virtual environment)
- [``cookiecutter``](https://python-package-generator.readthedocs.io/en/master/)
- [Docker](https://docs.docker.com/get-docker/) (if you wish to build and test the service locally)
- [``Docker``](https://docs.docker.com/get-docker/) (if you wish to build and test the service locally)

```console
sudo apt-get update
Expand Down
31 changes: 31 additions & 0 deletions cookiecutter.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
"author_name": "YourName YourSurname",
"author_email": "Your address email (eq. you@example.com)",
"author_affiliation": "University of Anywhere, Department of something",
"contact_email": "{{ cookiecutter.author_email }}",
"project_name": "Name of the project",
"project_slug": "{{ cookiecutter.project_name.lower().replace(' ', '-') }}",
"project_package_name": "{{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}",
"project_short_description": "{{ cookiecutter.project_name }}",
"docker_base": [
"quay.io/jupyter/minimal-notebook:python-3.11",
"quay.io/jupyter/r-notebook:r-4.3.3",
"quay.io/jupyter/julia-notebook:julia-1.10.2",
"custom:special-image"
],
"number_of_inputs": 4,
"number_of_outputs": 4,
"git_repo": [
"local",
"github",
"gitlab"
],
"git_username": "Yourusername",
"release_date": "{% now 'utc', '%Y' %}",
"version": "0.1.0",
"resources_CPU_nanoCPUs": 4000000000,
"resources_RAM_nanoBytes": 8000000000,
"_extensions": [
"jinja2_time.TimeExtension"
]
}

0 comments on commit 08ec8a4

Please sign in to comment.