Skip to content

Commit 7db2c7b

Browse files
committed
Minor enhancements
1 parent 8bbfe31 commit 7db2c7b

File tree

2 files changed

+26
-42
lines changed

2 files changed

+26
-42
lines changed

resources/BUILDING.md

Lines changed: 16 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -8,37 +8,21 @@ repository](../.github/CONTRIBUTING.md).
88

99

1010
## Table of contents
11-
12-
- [Building DynAdjust from source
13-
code](#building-dynadjust-from-source-code){#toc-building-dynadjust-from-source-code}
14-
- [Overview of
15-
prerequisites](#overview-of-prerequisites){#toc-overview-of-prerequisites}
16-
- [Linux (Ubuntu)](#linux-ubuntu){#toc-linux-ubuntu}
17-
- [Installing
18-
prerequisites](#installing-prerequisites){#toc-installing-prerequisites}
19-
- [Compile the source
20-
code](#compile-the-source-code){#toc-compile-the-source-code}
21-
- [MacOS](#macos){#toc-macos}
22-
- [Install
23-
prerequisites](#install-prerequisites){#toc-install-prerequisites}
24-
- [Compile the source
25-
code](#compile-the-source-code-1){#toc-compile-the-source-code-1}
26-
- [Windows using
27-
Cmake](#windows-using-cmake){#toc-windows-using-cmake}
28-
- [Install
29-
prerequisites](#install-prerequisites-1){#toc-install-prerequisites-1}
30-
- [Install Intel oneAPI MKL
31-
library](#install-intel-oneapi-mkl-library){#toc-install-intel-oneapi-mkl-library}
32-
- [Download the source
33-
code](#download-the-source-code){#toc-download-the-source-code}
34-
- [Compile the source
35-
code](#compile-the-source-code-2){#toc-compile-the-source-code-2}
36-
- [Windows using Visual
37-
Studio](#windows-using-visual-studio){#toc-windows-using-visual-studio}
38-
- [Install Windows
39-
prerequisites](#install-windows-prerequisites){#toc-install-windows-prerequisites}
40-
- [Building Windows binaries in Visual
41-
Studio](#building-windows-binaries-in-visual-studio){#toc-building-windows-binaries-in-visual-studio}
11+
- [Overview of prerequisites](#overview-of-prerequisites)
12+
- [Linux (Ubuntu)](#linux-ubuntu)
13+
- [Installing prerequisites](#installing-prerequisites)
14+
- [Compile the source code](#compile-the-source-code)
15+
- [MacOS](#macos)
16+
- [Install prerequisites](#install-prerequisites)
17+
- [Compile the source code](#compile-the-source-code-1)
18+
- [Windows using Cmake](#windows-using-cmake)
19+
- [Install prerequisites](#install-prerequisites-1)
20+
- [Install Intel oneAPI MKL library](#install-intel-oneapi-mkl-library)
21+
- [Download the source code](#download-the-source-code)
22+
- [Compile the source code](#compile-the-source-code-2)
23+
- [Windows using Visual Studio](#windows-using-visual-studio)
24+
- [Install Windows prerequisites](#install-windows-prerequisites)
25+
- [Building Windows binaries in Visual Studio](#building-windows-binaries-in-visual-studio)
4226

4327

4428
## Overview of prerequisites
@@ -83,7 +67,7 @@ sudo apt install -y libxerces-c-dev xsdcxx libboost-system-dev libboost-filesyst
8367
```
8468

8569
You now have two options,
86-
either[OpenBLAS](http://www.openmathlib.org/OpenBLAS/) or[Intel oneAPI
70+
either [OpenBLAS](http://www.openmathlib.org/OpenBLAS/) or [Intel oneAPI
8771
Math Kernel
8872
Library](https://www.intel.com/content/www/us/en/developer/tools/oneapi/onemkl.html).
8973

resources/INSTALLING.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ The steps required to install DynAdjust on your system will depend upon your ope
1414

1515
## Pre-built Binary Packages
1616

17-
[![GitHub Releases](https://img.shields.io/github/v/release/icsm-au/DynAdjust.svg)](https://github.com/icsm-au/DynAdjust/releases)
17+
[![GitHub Releases](https://img.shields.io/github/v/release/geoscienceaustralia/DynAdjust.svg)](https://github.com/geoscienceaustralia/DynAdjust/releases)
1818

19-
For each stable release, we publish pre-compiled **zip** archives for various platforms on the [releases page](https://github.com/icsm-au/dynadjust/releases/latest).
19+
For each stable release, we publish pre-compiled **zip** archives for various platforms on the [releases page](https://github.com/geoscienceaustralia/dynadjust/releases/latest).
2020

2121
| Zip file (example) | Platform | BLAS/LAPACK backend | Link type |
2222
|----------------------------------|--------------------------|---------------------|-----------|
@@ -27,19 +27,19 @@ For each stable release, we publish pre-compiled **zip** archives for various pl
2727
| `dynadjust-linux-openblas.zip` | Ubuntu 22.04 + | OpenBLAS | dynamic |
2828
| `dynadjust-linux-static.zip` | Any modern x86‑64 Linux | OpenBLAS | static |
2929

30-
Note that we build DynAdjust in two flavours: dynamic and static.
30+
Note that we build DynAdjust in two flavours: *dynamic* and *static*.
3131

3232
The *dynamic* build keeps the executable small and relies on shared system libraries that are already present, distributed by the operating system, or shared across multiple software packages. That means security patches and performance upgrades (e.g., new Intel MKL version) arrive automatically through normal system updates.
3333

34-
The *static* build moves in the opposite direction: we compile every required library directly into one self-contained binary. Nothing else has to be installed for the program to run, which is invaluable when we need to run DynAdjust in the cloud or in production as it provides an exact version for regulatory reproducibility. Because it is insulated from future changes in operating-system libraries, it gives us a deterministic, "known-good" binary that will behave identically next year even if the underlying machines, operating systems, or libraries are patched or replaced.
34+
The *static* build moves in the opposite direction: we combine every required library directly into one self-contained binary. Nothing else has to be installed for the program to run, which is invaluable when DynAdjust needs to be run in the cloud or in production as it provides an exact version for regulatory reproducibility. Because it is insulated from future changes in operating-system libraries, it gives us a deterministic, "known-good" binary that will behave identically even after the underlying machines, operating systems, or libraries are patched or replaced.
3535

3636
Maintaining both variants therefore gives us flexibility: the dynamic build inherits dependency updates automatically, while the static build guarantees portability and long-term reproducibility in controlled settings.
3737

38-
Each archive contains the six command‑line tools:
38+
Each archive contains the seven command‑line tools:
3939
```
40-
dnaadjust dnageoid dnaimport dnaplot dnareftran dnasegment
40+
dynadjust, dnaadjust, dnageoid, dnaimport, dnaplot, dnareftran, dnasegment
4141
```
42-
For dynamic builds additional shared libraries (`.dll`, `.so`, `.dylib`) are included and each DynAdjust command is broken into a wrapper executable and a shared library.
42+
For dynamic builds, additional shared libraries (`.dll`, `.so`, `.dylib`) are included and each DynAdjust command is broken into a wrapper executable and a shared library.
4343

4444
### Windows Packages
4545

@@ -67,9 +67,9 @@ vcpkg install boost-geometry boost-process boost-iostreams boost-spirit boost-sy
6767
```
6868

6969
Unzip **`dynadjust-windows-openblas.zip`** (e.g. to `C:\Tools\DynAdjust`) and run `dnaadjust.exe`.
70-
If Windows cannot find `libopenblas.dll` ensure `C:\vcpkg\installed-windows` is on `PATH`.
70+
If Windows cannot find `openblas.dll` ensure `%VCPKG_ROOT%\installed\x64-windows\bin` is on `PATH`.
7171

72-
#### Windows + MKL Package
72+
#### Windows + Intel MKL Package
7373

7474
Install the runtime DLLs with `vcpkg`
7575

@@ -138,7 +138,7 @@ If you see an error like **"cannot open shared object file"** revisit the prereq
138138

139139
### Troubleshooting Notes
140140

141-
* *Windows OpenBLAS*: missing DLL → ensure vcpkg `bin` directory is on `PATH`, then start a new terminal.
141+
* *Windows OpenBLAS*: missing DLLs → ensure vcpkg `bin` directory is on `PATH`, then start a new terminal.
142142
* *macOS*: Gatekeeper warnings can be cleared by opening the app via **right‑click → Open** once.
143143
* *Static Linux*: verify you downloaded the x86‑64 build (`uname -m` prints `x86_64`).
144144
* *Performance*: the MKL build generally runs faster on Intel CPUs; OpenBLAS is licence‑friendly and portable.

0 commit comments

Comments
 (0)