Skip to content

Commit

Permalink
Update-documentation for Docker and README and version for v5.3.1
Browse files Browse the repository at this point in the history
  • Loading branch information
dunyuliu committed Dec 9, 2023
1 parent 1118af9 commit b77effc
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 15 deletions.
14 changes: 7 additions & 7 deletions Docker.guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,30 +14,30 @@ c. For Linux users, to be explored. <br/>

Open a terminal and run the following command: <br/>
```
docker run -it --name eqdyna dunyuliu/eqdyna.docker
docker run -it --name ContainerName dunyuliu/eqdyna:v5.3.1
```
Note: for Windows users, you may need admin access for the Powershell. For MacOS users, it seems you don't need admin access (to be explored further). <br/>

## 3. Using the newly created EQdyna docker container! <br/>

a. After some downloading (1.14 GB), you will find a new image called dunyuliu/eqdyna.docker in the 'Images' tab in the Docker Desktop. <br/>
b. Also you will find a container with the name you give - eqdyna in the command above - running in the 'Containers' tab in the Docker Desktop. <br/>
a. After downloading the image dunyuliu/eqdyna:v5.3.1 (<1.5GB), you will find it in the 'Images' tab on the left control panel of Docker Desktop. <br/>
b. Also you will find a container with the name you give, i.e., ContainerName, running in the 'Containers' tab in Docker Desktop. <br/>
c. In the 'Actions' panel of the container, if you click the three dots, you will find an drop-down list. <br/>
Click 'Open in terminal' and you will be navigated to the terminal of the Ubuntu system. <br/>
d. Type 'bash', you will enter the $HOME directory where you can find useful information in the 0README.md. <br/>
e. Now you can enjoy running the EQdyna! <br/>
e. Now hope you can enjoy running the EQdyna! <br/>

## Appendix:
1. To commit a modified/developed container to a Docker image and push it to the Docker Hub.
```
docker commit container_name your_docker_hub_name/image_name:tag
docker commit ContainerName your_docker_hub_name/image_name:tag
```

2. To mount the newly created docker container to other hard drives. Additional to the above docker run command, you can specify a hard drive that is mounted to your system for additional space. It will be achieved by adding the -v option.

For example, in the following command, I mount the container to an external drive G:/docker.data and rename it to /mount shown in the container environment.
For example, in the following command, I mount the container to an external Windows OS drive G:/scratch, and rename it to /mount in my container environment.

```
docker run -it --name eqdyna.docker -v G:/docker.data:/mount dunyuliu/eqdyna.docker
docker run -it --name ContainerName -v G:/scratch:/mount dunyuliu/eqdyna:v5.3.1
```
24 changes: 18 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# News in 2023
* 20231130 v5.3.0 release notes
* refactor faulting.f90 and meshgen.f90;
* introduce a system for quick testing by running testAll.py;
* test system now supports tpv8, tpv104, tpv1053d, tpv1053d.6c, meng2023a, meng2023cb;
* update input parameter system with a single defaultParameters.py and customized user_defined_params.py;
* 20231209 v5.3.1 release notes
* Python utility generateFaultInterface is created to generate fractal and dipping fault interface;
* update the test system to compare the numerical residuals between test and reference results;
* support a new test test.tpv10, a 60 deg dipping fault;
* support a new test test.drv.a6, a fractal fault plastic model for ground motion application;
* refactoring and bug fixes.

# Introduction to *```EQdyna```*

Expand Down Expand Up @@ -86,12 +87,17 @@ source $EQDYNAROOT/test-all.sh
Four pre-defined test cases will be created and run using 4 CPUs, which will take a few minutes.

# Currently supported compset (more to come)
* drv.a6, for determinisitc ground motion with fractal fault and plasticity
* tpv8
* tpv10
* tpv104
* tpv1053d
* meng2023a, for stress inversion
* meng2023cb

# Benchmark computational performance and resource
TPV104: 15 seconds simulation time with 0.008 dt and a total of 1875 time steps. It took 40 CPUs to run 24.20 minutes on Lonestar6. <br/>
TPV1053D: 15 seconds simulation time with 0.008 dt and a total of 1875 time steps. It took 40 CPUs to run I

# Note
*```EQdyna```* is still under heavy development and comes without any guaranteed functionality. But we hope *```EQdyna```* would be easy to use and we bear this goal in mind when developing it.

Expand All @@ -105,6 +111,12 @@ We welcome developers and users. If you are interested in developing and collabo
* Liu, D. and B. Duan (2018). "Scenario Earthquake and Ground‐Motion Simulations in North China: Effects of Heterogeneous Fault Stress and 3D Basin Structure." BSSA.

# Past release notes
* 20231130 v5.3.0 release notes
* refactor faulting.f90 and meshgen.f90;
* introduce a system for quick testing by running testAll.py;
* test system now supports tpv8, tpv104, tpv1053d, tpv1053d.6c, meng2023a, meng2023cb;
* update input parameter system with a single defaultParameters.py and customized user_defined_params.py;

* 20230327
* *```EQdyna```* works on Ubuntu now.
* install-eqdyna.sh can support multiple systems.
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
5.3.0
5.3.1
2 changes: 1 addition & 1 deletion src/eqdyna3d.f90
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ PROGRAM EQdyna

if (me == master) then
write(*,*) '====================================================================='
write(*,*) '================== Welcome to EQdyna 5.3.0 ======================='
write(*,*) '================== Welcome to EQdyna 5.3.1 ======================='
write(*,*) '===== Product of Earthquake Modeling Lab @ Texas A&M University ====='
write(*,*) '==== & Institute for Geophysics, University of Texas at Austin ===='
write(*,*) '============== https://github.com/dunyuliu/EQdyna.git ==============='
Expand Down

0 comments on commit b77effc

Please sign in to comment.