diff --git a/README.md b/README.md index 534c22dc223659f433fe8a9f1dc7ff8631f15908..c137e9eb85eaec9d5668e5ebafd6b46aeca23e45 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,36 @@ -# GEANT4 +# *GEANT4* Docker -Repositorio del contenedor para el uso del software [**GEANT4**](https://geant4.web.cern.ch/) \ No newline at end of file +[*GEANT4*](https://geant4.web.cern.ch) en contenedor [Docker](https://www.docker.com/). + +## Instrucciones de uso + +A continuación las instrucciones para crear el contenedor *GEANT4*. + +### Requisitos + +Para utilizar esta herramienta se requiere tener instalado el software [Docker](https://www.docker.com/) y las intrucciones de instalación se encuentran en [https://docs.docker.com/engine/install/](https://docs.docker.com/engine/install/). + +> Se han realizado pruebas hasta ahora en sistemas GNU/Linux (Ubuntu, Debian, CentOS) + +### Crear contenedor *GEANT4* + +A continuación las instrucciones para crear el contenedor *offline*. + +1. Descargar la imagen desde *Docker Hub* + `docker pull halleyuis/geant4:latest` +2. Crear el contenedor + `docker run -dit --name geant4 --net=host --env="DISPLAY" --volume="$HOME/.Xauthority:/root/.Xauthority:rw" -v {{directorioLocal}}/:/data halleyuis/geant4:latest` + donde: + - **{{directorioLocal}}** Es la ruta a algún directorio del Host para compartir archivos con el contenedor. [Opcional] + - Los parámetros *net*, *env* y *volumen* permiten la ejecución de interfaces gráficas + - *geant4* es el nombre del contendor. [Puede usarse cualquier otro nombre] + +### Ingresar al contenedor + +Para ingresar en modo terminal al contenedor se ejecuta el siguiente comando. + +```docker exec -it geant4 bash``` + +Donde **geant4** es el nombre asignado al contenedor. + +Al ingresar al contenedor podrá usar el software *GEANT4* desde la ruta de instalación `/opt/geant4` y los ejemplos en el directorio `/root/examples-geant4`.