Skip to content

Commit

Permalink
Update link locations in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
timothy-nunn committed Aug 16, 2023
1 parent c158c4d commit be53d21
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 19 deletions.
12 changes: 3 additions & 9 deletions documentation/proc-pages/installation/installation-docker.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Installation using Docker

!!! Note "Note"
This section is for users of a privileged machine of the wrong OS e.g MacOS. If you are a using a shared resource e.g. computing cluster, please go [here](#singularity-container).*
This section is for users of a privileged machine of the wrong OS e.g MacOS. If you are a using a shared resource e.g. computing cluster, please go [here](https://ukaea.github.io/PROCESS/installation/installation-singularity/).*

PROCESS can be run on Mac or in other environments inside a Docker container. The PROCESS
repository, including source and build directories, remain in the host filesystem, but the
Expand All @@ -22,23 +22,17 @@ using `homebrew`:
brew --cask install docker
```

Then login to the Gitlab container registry:

```
docker login git.ccfe.ac.uk:4567
```

Then download the Docker image from the Process Gitlab container registry:

```
docker pull git.ccfe.ac.uk:4567/process/process/dev
docker pull ghcr.io/ukaea/process-ci:latest
```

Running `docker image ls` should show the image in your local Docker image repository. Optionally,
you can change the image name to something more manageable:

```
docker tag git.ccfe.ac.uk:4567/process/process/dev process-dev
docker tag ghcr.io/ukaea/process-ci:latest process-dev
```

to rename the image to "process-dev" with the "latest" tag: "process:latest".
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@


# Installation using Singularity container
# Installation using Singularity/Apptainer container

Singularity is a container environment similar to Docker. This means a user can run PROCESS with
all required dependencies installed. Singularity, however, is designed to work with user-level
Expand All @@ -11,7 +11,7 @@ Singularity can convert OCI compliant containers into the Singularity Image Form
the Docker container above. Download, and convert the Docker container by running:

```bash
singularity pull --docker-login process.sif docker://git.ccfe.ac.uk:4567/process/process/dev:latest
apptainer pull process.sif docker://ghcr.io/ukaea/process-ci:latest
```

Singularity will then ask for a username and password, your CCFE GitLab short username and
Expand All @@ -20,7 +20,7 @@ copied like any file. Running the following command will load a Singularity shel
dependencies for PROCESS installed:

```bash
singularity shell process.sif
apptainer shell process.sif
```

Singularity will automatically mount your home (`$HOME`) directory into the container. Therefore,
Expand All @@ -45,13 +45,13 @@ module load singularity/3.7.1
Pull the Singularity image and enter your git username and password when prompted:

```bash
singularity pull --docker-login process.sif docker://git.ccfe.ac.uk:4567/process/process/dev:latest
apptainer pull process.sif docker://ghcr.io/ukaea/process-ci:latest
```

Make sure you have created [ssh keys](https://docs.gitlab.com/ee/ssh/) and open the Singularity shell:

```bash
singularity shell process.sif
apptainer shell process.sif
```

Singularity is an environment which allows you to use dependencies not available on Freia, like
Expand All @@ -68,4 +68,4 @@ cmake --build build
```

Now you can run commands within the shell like `process -i tests/regression/scenarios/large-tokamak/IN.DAT`
to verify installation and create [batch jobs](http://process.gitpages.ccfe.ac.uk/process/io/utilities-guide/).
to verify installation and create [batch jobs](https://ukaea.github.io/PROCESS/io/utilities/).
8 changes: 4 additions & 4 deletions documentation/proc-pages/installation/installation-ubuntu.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ and the advantages of use.

!!! Info "OS"
This section is for users on a Windows system, if you are a MacOS or privileged machine user
please go [here](#docker-container), or if you are a using a shared resource, please
go [here](#singularity-container).
please go [here](https://ukaea.github.io/PROCESS/installation/installation-docker/), or if you are a using a shared resource, please
go [here](https://ukaea.github.io/PROCESS/installation/installation-singularity/).

To install Windows Subsystem for Linux (WSL) follow the 'Manual Installation Steps'
[here](https://docs.microsoft.com/en-us/windows/wsl/install-win10). Choose WSL 2 and Ubuntu 20 (if
Expand Down Expand Up @@ -109,12 +109,12 @@ pytest

which runs unit, integration, and regression tests.

A more in-depth discussion of testing can be found [here](http://process.gitpages.ccfe.ac.uk/process/development/testing/).
A more in-depth discussion of testing can be found [here](https://ukaea.github.io/PROCESS/development/testing/).

If everything passes, this indicates a successful installation. If anything fails, this indicates
that your environment produces different results to what is expected. You might consider
creating an issue in GitHub, or trying out the
[Docker container](http://process.gitpages.ccfe.ac.uk/process/installation/installation-docker) instead.
[Docker container](https://ukaea.github.io/PROCESS/installation/installation-docker/) instead.

!!! Question "Installation troubleshooting"

Expand Down

0 comments on commit be53d21

Please sign in to comment.