Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Fixing typos and changing the repository name
  • Loading branch information
nilodna authored Jun 5, 2024
1 parent 27dbc90 commit 7706605
Showing 1 changed file with 8 additions and 10 deletions.
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# docker-roms- Docker image to run the Regional Ocean Modeling System - ROMS
# docker4roms- Docker image to run the Regional Ocean Modeling System - ROMS

Creating a docker image, based on ubuntu 20.04, to run Regional Ocean Modeling System - ROMS, under any version of linux.

Expand All @@ -8,15 +8,13 @@ and adapted by @nilodna for all Hydrodynamics Lab fellows.

## General comments

There is two types configuration to use docker4roms. The first is specific for personal computers, where the user has root privileges. The second one was designed to run
in the shelfwaves workstation, sharing a common ID for a specific docker group, allowing the researches to run their numerical simulations and still have access to the
netCDF files generated.
There are two types of configurations to use docker4roms. The first is specific to personal computers, where the user has root privileges.

## Pre-requisites

- Install docker in your system. See [here](https://docs.docker.com/engine/installation/).
- Right folder structures:
- your_folder/docker-roms: this repository's folder
- your_folder/docker4roms: this repository's folder
- your_folder/projects: folder with your projects to run
- your_folder/src_code: you must download the ROMS source code here

Expand Down Expand Up @@ -50,7 +48,7 @@ Notice that the following option allows multiple containers from a single image.
docker-compose -f docker-compose-personal.yml -p roms_user up -d
```

With this command, the docker-compose software will build the right docker4roms release to your case, create two shared folder between host and container, sharing the ROMS source code and your projects setup and put all this to run in background (```-d```).
With this command, the docker-compose software will build the right docker4roms release to your case, create two shared folders between host and container, share the ROMS source code and your project setup, and put all this to run in the background (```-d```).

Note that the container building process will create two new folders on ```../``` of your structure. These two folders are fundamental to the Docker4ROMS usability, holding the source code of ROMS and your projects (numerical experiments). Make sure to copy the ```build_roms.sh``` file to the projects before accessing the container.

Expand All @@ -65,7 +63,7 @@ and you will access the working directory ```/home/lhico``` with two folders: ro

## Running my first test case - upwelling

This repository contains a ```build_roms.sh``` pre configure to be used inside the docker4roms structure. You must copy this file inside your ```projects``` folder and run the following steps for the UPWELLING test case:
This repository contains a ```build_roms.sh```pre-configure to be used inside the docker4roms structure. You must copy this file inside your ```projects``` folder and run the following steps for the UPWELLING test case:

```
# outside the container, first follow this sequence of codes:
Expand All @@ -75,16 +73,16 @@ chmod 777 upwelling # give full writing and reading privileges
cd upwelling
# copy files for the UPWELLING test case
cp ../../docker-roms/build_roms.sh .
cp ../../docker4roms/build_roms.sh .
cp ../../src_code/ROMS/External/roms_upwelling.in .
cp ../../src_code/ROMS/External/varinfo.yaml .
cp ../../src_code/ROMS/Include/upwelling.h .
# Now, access your container:
docker exec -it roms_user bash
# Once inside the container, go to projects folder and create a new folder
# note that the build_roms.sh must be in the projects folder.
# Once inside the container, go to the projects folder and create a new folder
# Note that the build_roms.sh must be in the projects folder.
cd projects; mkdir upwelling
# Now you need to copy the upwelling configuration files, that came with the ROMS source code
Expand Down

0 comments on commit 7706605

Please sign in to comment.