https://github.com/hereariim/deep-oc-blossom
deep oc repository
https://github.com/hereariim/deep-oc-blossom
Last synced: 4 months ago
JSON representation
deep oc repository
- Host: GitHub
- URL: https://github.com/hereariim/deep-oc-blossom
- Owner: hereariim
- License: mit
- Created: 2022-07-26T19:36:24.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-02T13:20:18.000Z (over 3 years ago)
- Last Synced: 2023-03-05T16:49:22.776Z (over 3 years ago)
- Language: Dockerfile
- Size: 27.3 KB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DEEP-OC-blossom
[](https://jenkins.indigo-datacloud.eu/job/Pipeline-as-code/job/DEEP-OC-org/job/UC-hereariim-DEEP-OC-blossom/job/master)
This is a container that will run [blossom](https://github.com/hereariim/blossom) application leveraging the DEEP as a Service API component ([DEEPaaS API V2](https://github.com/indigo-dc/DEEPaaS)).
## Running the container
### Directly from Docker Hub
To run the Docker container directly from Docker Hub and start using the API
simply run the following command:
```bash
$ docker run -ti -p 5000:5000 -p 6006:6006 deephdc/uc-hereariim-deep-oc-blossom
```
This command will pull the Docker container from the Docker Hub
[deephdc](https://hub.docker.com/u/deephdc/) repository and start the default command (deepaas-run --listen-ip=0.0.0.0).
**N.B.** For either CPU-based or GPU-based images you can also use [udocker](https://github.com/indigo-dc/udocker).
### Running via docker-compose
docker-compose.yml allows you to run the application with various configurations via docker-compose, for example:
```bash
$ docker-compose up blossom
```
**N.B!** docker-compose.yml is of version '2.3', one needs docker 17.06.0+ and docker-compose ver.1.16.0+, see https://docs.docker.com/compose/install/
If you want to use Nvidia GPU, you need nvidia-docker and docker-compose ver1.19.0+ , see [nvidia/FAQ](https://github.com/NVIDIA/nvidia-docker/wiki/Frequently-Asked-Questions#do-you-support-docker-compose)
### Building the container
If you want to build the container directly in your machine (because you want
to modify the `Dockerfile` for instance) follow the following instructions:
Building the container:
1. Get the `DEEP-OC-blossom` repository (this repo):
```bash
$ git clone https://github.com/hereariim/DEEP-OC-blossom
```
2. Build the container:
```bash
$ cd DEEP-OC-blossom
$ docker build -t deephdc/uc-hereariim-deep-oc-blossom .
```
3. Run the container (if you enable JupyterLab during the build, `--build-arg jlab=true`,
you should also add port 8888, i.e. `-p 8888:8888`):
```bash
$ docker run -ti -p 5000:5000 -p 6006:6006 deephdc/uc-hereariim-deep-oc-blossom
```
These three steps will download the repository from GitHub and will build the
Docker container locally on your machine. You can inspect and modify the
`Dockerfile` in order to check what is going on. For instance, you can pass the
`--debug=True` flag to the `deepaas-run` command, in order to enable the debug
mode.
## Connect to the API
Once the container is up and running, browse to `http://localhost:5000` to get
the [OpenAPI (Swagger)](https://www.openapis.org/) documentation page.