Skip to content

Commit 2c56ef9

Browse files
committed
update readme.rst for dockers
1 parent 855375d commit 2c56ef9

File tree

2 files changed

+39
-19
lines changed

2 files changed

+39
-19
lines changed

docker/pre/README.rst

Lines changed: 37 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,43 @@
11
Create your own pydyna-pre service docker container
2-
:::::::::::::::::::::::::::::::::::::::::::::::::::
2+
===================================================
33

44
The pydyna-pre service Docker containers can be easily built by following
55
these steps.
66

7-
To build the docker image you will need to clone pydyna repo locally:
7+
Inside this folder, the instructions (i.e. ``Dockerfile`` files) for
8+
building the pydyna-pre service Docker containers are made available.
89

9-
.. code:: console
10-
11-
git clone https://github.com/pyansys/pydyna.git
12-
cd pydyna
13-
14-
* ``docker/pre/Dockerfile``: this file builds the Linux-based Docker image.
10+
* ``Dockerfile``: this file builds the Linux-based Docker image.
1511

1612
Prerequisites
1713
^^^^^^^^^^^^^
1814

1915
* Ensure that ``docker`` is installed in your machine.
2016
If you do not have ``docker`` available, please refer to the
2117
`official Docker site <https://www.docker.com>`_.
18+
Note that the container can also be started on Windows if the Docker Desktop has been installed.
19+
How to install the Docker Desktop: https://docs.docker.com/desktop/install/windows-install/
20+
21+
* Download the latest release artifacts. You can do this as follows:
22+
23+
* Latest Linux artifacts: `linux-binaries.zip <https://github.com/ansys/pydyna/releases/download/v0.3.1/linux-binaries.zip>`_
24+
25+
* Move these ``.zip`` files to the current location (i.e. ``<repository-root-folder>/docker/pre``).
2226

23-
* Download the latest release artifacts for the Linux
24-
Docker container. You can do this as follows:
27+
Starting the docker container
28+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2529

26-
* Latest Linux artifacts: `linux-binaries.zip <https://github.com/ansys/pydyna/releases/download/v0.2.1/linux-binaries.zip>`_
30+
There are two ways to start docker container.
2731

28-
* Move these ``.zip`` files to the current location (i.e. ``<repository-root-folder>/docker``).
32+
1.bulid image and run container
33+
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
2934

3035
Building the Docker images
31-
^^^^^^^^^^^^^^^^^^^^^^^^^^
36+
::::::::::::::::::::::::::
3237

3338
In order to build your images, follow the next instructions:
3439

35-
* Locate yourself at ``<repository-root-folder>/docker`` in your terminal.
40+
* Locate yourself at ``<repository-root-folder>/docker/pre`` in your terminal.
3641
* Run the following Docker command:
3742

3843
.. code:: bash
@@ -56,13 +61,13 @@ In order to build your images, follow the next instructions:
5661
>>> ...... ...... ............ .............. ......
5762
5863
Run the image as a container
59-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
64+
::::::::::::::::::::::::::::
6065

6166
* Run the following Docker command:
6267

6368
.. code:: bash
6469
65-
docker run -d -p 50051:50051 ghcr.io/ansys/ls-pre .
70+
docker run -d -p 50051:50051 ghcr.io/ansys/ls-pre
6671
6772
* Check that the image has been created successfully.
6873

@@ -71,4 +76,19 @@ Run the image as a container
7176
7277
7378
>>> CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
74-
>>> c77ffd67f9fa ghcr.io/ansys/ls-pre "python3 ./linux-bin…" 7 seconds ago Up 7 seconds 0.0.0.0:50051->50051/tcp, :::50051->50051/tcp hardcore_margulis
79+
>>> c77ffd67f9fa ghcr.io/ansys/ls-pre "python3 ./linux-bin…" 7 seconds ago Up 7 seconds 0.0.0.0:50051->50051/tcp, :::50051->50051/tcp hardcore_margulis
80+
81+
82+
2.Start the container from docker-compose.yml file
83+
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
84+
85+
Make sure the docker compose have been installed on your computer.
86+
For more information: https://docs.docker.com/compose/install/
87+
88+
* Locate yourself at ``<repository-root-folder>/docker/pre`` in your terminal.
89+
* Run the following Docker command:
90+
91+
.. code:: bash
92+
93+
docker compose up -d
94+

docker/solver/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Prerequisites
1919
* Download the latest release artifacts for the Linux
2020
Docker container. You can do this as follows:
2121

22-
* Latest Linux artifacts: `mppdyna_docker_centos7.zip <https://github.com/ansys/pydyna/releases/download/v0.2.1/mppdyna_docker_centos7.zip>`_
22+
* Latest Linux artifacts: `mppdyna_docker_centos7.zip <https://github.com/ansys/pydyna/releases/tag/v0.3.1/mppdyna_docker_centos7.zip>`_
2323

2424
* Move these ``.zip`` files to a local directory ``local_image_build_dir``.
2525

@@ -56,7 +56,7 @@ Run the image as a container
5656

5757
.. code:: bash
5858
59-
docker-compose up
59+
docker compose up
6060
6161
* Check that the image has been created successfully.
6262

0 commit comments

Comments
 (0)