Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/source/changelog/958.documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Improve docker install documentation
19 changes: 9 additions & 10 deletions doc/source/getting-started/install/linux/docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,15 @@ the latest three stable versions of Python.
Download STK artifacts
======================

Download the ``STK Engine`` and ``STK Engine Deployment Resources`` artifacts for
Linux platforms from the `https://support.agi.com/downloads
<https://support.agi.com/downloads>`_ page.
Download the ``STK Engine on Linux`` and ``STK Engine on Linux Data`` artifacts from
the `https://support.agi.com/downloads <https://support.agi.com/downloads>`_ page.

Place the artifacts inside a directory named ``distributions``. This directory
must be contained inside of the ``stk-engine`` directory.
Extract the contents of the compressed artifacts into a directory named ``distributions``.
This directory must be contained inside of the ``stk-engine`` directory.

.. code-block:: dosbatch

linux/
linux/ubuntu
├── docker-compose.yml
├── stk-engine
│  └── distributions/
Expand All @@ -47,12 +46,12 @@ must be contained inside of the ``stk-engine`` directory.
Build Docker images
===================

Navigate to the ``linux`` directory and use `Docker Compose`_ to build the
Navigate to the ``linux/ubuntu`` directory and use `Docker Compose`_ to build the
image of your choice by running:

.. code-block:: dosbatch

docker compose build stk-engine-py3<minor>
docker compose build stk-python3.<minor>

where ``<minor>`` is one of the minor versions of Python.

Expand Down Expand Up @@ -169,7 +168,7 @@ with the container, it is possible to install the package by running:

docker exec \
--interactive --tty \
stk-python-3.<minor> \
stk-python3.<minor> \
/bin/bash -c "cd /home/stk && python -m venv .venv && source .venv/bin/activate && python -m pip install --upgrade pip && python -m pip install -e /home/stk/pystk[tests,doc,visualization]"

where ``<minor>`` is the minor version of Python selected when building the
Expand All @@ -184,7 +183,7 @@ Save your scripts inside the working directory. Then, execute them by running:

docker exec \
--interactive --tty \
stk-python-3.<minor> \
stk-python3.<minor> \
/bin/bash -c "python /home/stk/pystk/<script>"

Where ``<script>`` is the name of the Python script you want to execute.
14 changes: 11 additions & 3 deletions doc/source/getting-started/install/windows/docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,12 @@ Windows platforms from the `https://support.agi.com/downloads
Place the artifacts inside a directory named ``distributions``. This directory
must be contained inside of the ``stk-engine`` directory.

.. note::

If you require the Code500 ephemeris file export option, copy
``AgAsCode500.dll``, found in the ``"C:\Program Files\AGI\STK_ODTK 13\Modules"``
directory of an STK Desktop installation, to the ``distributions`` directory.

.. code-block:: dosbatch

windows/
Expand All @@ -52,7 +58,9 @@ image of your choice by running:

.. code-block:: dosbatch

docker compose build stk-engine-py3<minor>
docker compose build stk --build-arg agreeToLicense=yes
docker compose build stk-pybase
docker compose build stk-python3.<minor>

where ``<minor>`` is one of the minor versions of Python.

Expand Down Expand Up @@ -164,7 +172,7 @@ with the container, it is possible to install the package by running:

docker exec \
--interactive --tty \
stk-python-3.<minor> \
stk-python3.<minor> \
cmd /C "python -m venv .venv && cd pystk && chcp 65001 && call C:\Users\STK\.venv\Scripts\activate.bat && python -m pip install --upgrade pip && python -m pip install -e C:\Users\STK\pystk[tests,doc,visualization]"


Expand All @@ -180,7 +188,7 @@ Save your scripts inside the working directory. Then, execute them by running:

docker exec \
--interactive --tty \
stk-python-3.<minor> \
stk-python3.<minor> \
cmd /C "python /home/stk/pystk/<script>"

Where ``<script>`` is the name of the Python script you want to execute.
2 changes: 1 addition & 1 deletion docker/windows/stk-engine-py310/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ COPY scripts C:/dist/
SHELL ["powershell", "-Command", "$ErrorActionPreference = 'Stop'; $ProgressPreference = 'SilentlyContinue';"]

# Install Python
RUN Invoke-WebRequest -Uri "https://www.python.org/ftp/python/3.10.18/python-3.10.18-amd64.exe" -OutFile C:\dist\python-3.10.18-amd64.exe
ADD "https://www.python.org/ftp/python/3.10.18/python-3.10.18-amd64.exe" "C:\dist\python-3.10.18-amd64.exe"

RUN C:\dist\install.ps1

Expand Down
2 changes: 1 addition & 1 deletion docker/windows/stk-engine-py311/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ COPY scripts C:/dist/
SHELL ["powershell", "-Command", "$ErrorActionPreference = 'Stop'; $ProgressPreference = 'SilentlyContinue';"]

# Install Python
RUN Invoke-WebRequest -Uri "https://www.python.org/ftp/python/3.11.9/python-3.11.9-amd64.exe" -OutFile C:\dist\python-3.11.9-amd64.exe
ADD "https://www.python.org/ftp/python/3.11.9/python-3.11.9-amd64.exe" "C:\dist\python-3.11.9-amd64.exe"

RUN C:\dist\install.ps1

Expand Down
2 changes: 1 addition & 1 deletion docker/windows/stk-engine-py312/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ COPY scripts C:/dist/
SHELL ["powershell", "-Command", "$ErrorActionPreference = 'Stop'; $ProgressPreference = 'SilentlyContinue';"]

# Install Python
RUN Invoke-WebRequest -Uri "https://www.python.org/ftp/python/3.12.4/python-3.12.4-amd64.exe" -OutFile C:\dist\python-3.12.4-amd64.exe
ADD "https://www.python.org/ftp/python/3.12.4/python-3.12.4-amd64.exe" "C:\dist\python-3.12.4-amd64.exe"

RUN C:\dist\install.ps1

Expand Down
2 changes: 1 addition & 1 deletion docker/windows/stk-engine-py313/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ COPY scripts C:/dist/
SHELL ["powershell", "-Command", "$ErrorActionPreference = 'Stop'; $ProgressPreference = 'SilentlyContinue';"]

# Install Python
RUN Invoke-WebRequest -Uri "https://www.python.org/ftp/python/3.13.0/python-3.13.0-amd64.exe" -OutFile C:\dist\python-3.13.0-amd64.exe
ADD "https://www.python.org/ftp/python/3.13.0/python-3.13.0-amd64.exe" "C:\dist\python-3.13.0-amd64.exe"

RUN C:\dist\install.ps1

Expand Down
2 changes: 1 addition & 1 deletion docker/windows/stk-engine/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ SHELL ["cmd", "/S", "/C"]

RUN icacls "C:\Users\STK" /grant STK:(OI)(CI)F /T
USER STK
RUN [ "C:/Program Files/AGI/STK 12/bin/AgNewUserSetup.exe", "force", "showDlg=Off", "allowOnline" ]
RUN [ "C:/Program Files/AGI/STK_ODTK 13/bin/AgNewUserSetup.exe", "force", "showDlg=Off", "allowOnline" ]

WORKDIR "C:\Users\STK"

Expand Down
7 changes: 5 additions & 2 deletions docker/windows/stk-engine/scripts/install.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ foreach ($zipFile in $zipFiles) {
Write-Host "Extracting $zipFile"
$zipFile -match "(?<archive>.*)\.zip" | Out-Null
$dirname = $matches['archive']
Expand-Archive -Path "C:/Users/STK/dist/$zipFile" -DestinationPath C:/Users/STK/dist/
Expand-Archive -Path "C:/Users/STK/dist/$zipFile" -DestinationPath "C:/Users/STK/dist/$dirname" -Force
Write-Host "Extracted $zipFile"

# Install current ZIP using setup.exe
Expand All @@ -29,6 +29,9 @@ foreach ($zipFile in $zipFiles) {
Remove-Item -Path "C:/Users/STK/dist/$dirname" -Force -Recurse
}

Copy-Item "C:\Program Files\AGI\STK_ODTK 13\bin\AgAsCode500.dll" -Destination "C:\Program Files\AGI\STK_ODTK 13\Modules"
$source = "C:/Users/STK/dist/AgAsCode500.dll"
if (Test-Path $source) {
Copy-Item -Path $source -Destination "C:\Program Files\AGI\STK_ODTK 13\Modules"
}

Remove-Item -Path C:/Users/STK/dist/ -Force -Recurse
Loading