diff --git a/hugo/content/installation/_index.md b/hugo/content/deploy/_index.md similarity index 100% rename from hugo/content/installation/_index.md rename to hugo/content/deploy/_index.md diff --git a/hugo/content/installation/building/_index.md b/hugo/content/deploy/building/_index.md similarity index 100% rename from hugo/content/installation/building/_index.md rename to hugo/content/deploy/building/_index.md diff --git a/hugo/content/installation/building/unix/_index.md b/hugo/content/deploy/building/unix/_index.md similarity index 100% rename from hugo/content/installation/building/unix/_index.md rename to hugo/content/deploy/building/unix/_index.md diff --git a/hugo/content/installation/building/unix/build-and-install.md b/hugo/content/deploy/building/unix/build-and-install.md similarity index 100% rename from hugo/content/installation/building/unix/build-and-install.md rename to hugo/content/deploy/building/unix/build-and-install.md diff --git a/hugo/content/installation/building/unix/first-simulation.md b/hugo/content/deploy/building/unix/first-simulation.md similarity index 100% rename from hugo/content/installation/building/unix/first-simulation.md rename to hugo/content/deploy/building/unix/first-simulation.md diff --git a/hugo/content/installation/building/unix/get-source.md b/hugo/content/deploy/building/unix/get-source.md similarity index 100% rename from hugo/content/installation/building/unix/get-source.md rename to hugo/content/deploy/building/unix/get-source.md diff --git a/hugo/content/installation/building/unix/third-party.md b/hugo/content/deploy/building/unix/third-party.md similarity index 90% rename from hugo/content/installation/building/unix/third-party.md rename to hugo/content/deploy/building/unix/third-party.md index 7763b317bdcf7b0f231fca673fae541c5376c86b..512c16e9f610df767d931d5e1792d1be5894b237 100644 --- a/hugo/content/installation/building/unix/third-party.md +++ b/hugo/content/deploy/building/unix/third-party.md @@ -7,8 +7,8 @@ weight = 10 As a prerequisite, Python and some Python modules must be installed. For the recommended installation under pyenv, see -* [Python on Linux](/installation/py/linux). -* [Python on Mac](/installation/py/mac). +* [Python on Linux](/deploy/py/linux). +* [Python on Mac](/deploy/py/mac). Further required software: @@ -61,7 +61,7 @@ $ sudo apt-get install build-essential git cmake \ If CMake fails with "Could NOT find OpenGL", then install `libgl1-mesa-dev`. If it fails with "Could NOT find OpenGL (missing: EGL)", then install `libegl1-mesa-dev`. -We assume that Python is [installed under pyenv]({{% relref "installation/py/linux" %}})); +We assume that Python is [installed under pyenv]({{% relref "deploy/py/linux" %}})); otherwise we also need the packages ``` python3 python3-dev python3-pip python3-numpy python3-matplotlib python3-lmfit @@ -80,7 +80,7 @@ $ sudo zypper install gcc-c++ git-core cmake gsl-devel \ libqt6-qtbase-devel libqt6-qttools-devel libqt6-qtsvg-devel ``` -We assume that Python is [installed under pyenv]({{% relref "installation/py/linux" %}})); +We assume that Python is [installed under pyenv]({{% relref "deploy/py/linux" %}})); otherwise we also need the packages ``` python3-devel python3-pip \ @@ -100,7 +100,7 @@ pip3 install matplotlib numpy By default, Homebrew installs packages to `/opt/homebrew` or `/usr/local`, depending on the architecture dependent MacOS version. Possibly, this path has to be passed to CMake using the argument `-DCMAKE_PREFIX_PATH` -(see the [build instructions]({{% relref "installation/building/unix/build-and-install" %}})). +(see the [build instructions]({{% relref "deploy/building/unix/build-and-install" %}})). Add Qt to your path environment variable: ``` diff --git a/hugo/content/installation/building/windows/index.md b/hugo/content/deploy/building/windows/index.md similarity index 99% rename from hugo/content/installation/building/windows/index.md rename to hugo/content/deploy/building/windows/index.md index 65b54074c1f83425d5dbe9f5cca5fa65d5fa9345..23a4c21d25ca9bc99d977dfcb90c2ca4bf6c428d 100644 --- a/hugo/content/installation/building/windows/index.md +++ b/hugo/content/deploy/building/windows/index.md @@ -41,7 +41,7 @@ Download the **Windows x64 Installer** from the official website [cmake.org/down #### Python + Packages Python and some Python modules must be installed, as described in -[Python on Windows](/installation/py/win). +[Python on Windows](/deploy/py/win). #### SWIG diff --git a/hugo/content/deploy/install/_index.md b/hugo/content/deploy/install/_index.md new file mode 100644 index 0000000000000000000000000000000000000000..35483bda5177dc9335908a22fae8c60ae01d49a6 --- /dev/null +++ b/hugo/content/deploy/install/_index.md @@ -0,0 +1,19 @@ ++++ +title = "Install BornAgain" +weight = 10 ++++ + +## Installing BornAgain + +To install BornAgain from binary packages, follow these platform-specific instructions: + + * [Linux](linux) + * [Windows](windows) + * [Mac](macos) + +Usually, we recommend installing the latest public release. + +However, users who need specific novel features or/and are willing to help us as testers +are welcome to download the latest + + * [development snapshot](snapshot) diff --git a/hugo/content/installation/install/linux.md b/hugo/content/deploy/install/linux.md similarity index 98% rename from hugo/content/installation/install/linux.md rename to hugo/content/deploy/install/linux.md index 514838d4f10b051c07327d6ec3c0d19cf9259166..dad15d92f5fa166a3332c8dafd503caefa720554 100644 --- a/hugo/content/installation/install/linux.md +++ b/hugo/content/deploy/install/linux.md @@ -10,7 +10,7 @@ weight = 30 ##### Python As a prerequisite, Python must be installed. -For the recommended installation under pyenv, see [Python on Linux](/installation/py/linux). +For the recommended installation under pyenv, see [Python on Linux](/deploy/py/linux). ##### glibc diff --git a/hugo/content/installation/install/macos.md b/hugo/content/deploy/install/macos.md similarity index 97% rename from hugo/content/installation/install/macos.md rename to hugo/content/deploy/install/macos.md index 50b778405a503b86bdfb3e30314c0c76c0500b37..66115e5ce19da7f79eb8ffc8351a2a33dd145131 100644 --- a/hugo/content/installation/install/macos.md +++ b/hugo/content/deploy/install/macos.md @@ -7,7 +7,7 @@ weight = 70 #### Prequisite: Python -As a prerequisite, Python must be installed, see [Python on Mac](/installation/py/mac). +As a prerequisite, Python must be installed, see [Python on Mac](/deploy/py/mac). #### Install BornAgain as Python-only package diff --git a/hugo/content/deploy/install/snapshot.md b/hugo/content/deploy/install/snapshot.md new file mode 100644 index 0000000000000000000000000000000000000000..15ae7109d53fbd3ae485855ce21f563b682d444b --- /dev/null +++ b/hugo/content/deploy/install/snapshot.md @@ -0,0 +1,28 @@ ++++ +title = "Development snapshot" +weight = 90 ++++ + +## Install development snapshot + +Usually, we recommend installing the latest public release. +However, users who need specific novel features or/and are willing to help us as testers +are welcome to download the latest development snapshot. + +Here, we explain the download path for Windows. +For other platforms, pertinent paths will be easily found by analogy. + +Go to the jobs listing at https://jugit.fz-juelich.de/mlz/bornagain/-/jobs. + +Look for an entry like +{{< figscg src="/img/job_win_main.png" class="float-left">}} +that has the green tag <img src="/img/job_tag_passed.png"/>, +the gray tag <img src="/img/job_tag_main.png"/>, +and the blue tag <img src="/img/job_tag_win.png"/>. + +Follow the link underneath the green "Passed" tag <img src="/img/job_tag_passed.png"/> to page +that shows the build log. On the right margin, +there is a "Job artifacts" section: +{{< figscg src="/img/job_artifacts.png" class="float-left">}} +Follow the link "Browse", then "build", then "installer". +With two more clicks, download the installer. diff --git a/hugo/content/installation/install/windows.md b/hugo/content/deploy/install/windows.md similarity index 92% rename from hugo/content/installation/install/windows.md rename to hugo/content/deploy/install/windows.md index 0eace7b7cc1b0def8530dcaeec19ebbf8e8601f6..dfe08075ed98c536464a37d59fb0c630cc897c34 100644 --- a/hugo/content/installation/install/windows.md +++ b/hugo/content/deploy/install/windows.md @@ -7,7 +7,7 @@ weight = 50 #### Install Python environment -As a prerequisite, Python must be installed, see [Python on Windows](/installation/py/win). +As a prerequisite, Python must be installed, see [Python on Windows](/deploy/py/win). #### Install BornAgain as a Python package @@ -48,7 +48,7 @@ Frequent problems include the following: This message appears on running `BornAgain.exe` if BornAgain cannot find Python libraries. -If Python is correctly installed on the system according to [Install Python environment]({{% relref "installation/install/windows#install-python-environment" %}}), check if it discoverable by the system. Open command line or PowerShell and type +If Python is correctly installed on the system according to [Install Python environment]({{% relref "deploy/install/windows#install-python-environment" %}}), check if it discoverable by the system. Open command line or PowerShell and type ``` $ python ``` diff --git a/hugo/content/installation/py/_index.md b/hugo/content/deploy/py/_index.md similarity index 86% rename from hugo/content/installation/py/_index.md rename to hugo/content/deploy/py/_index.md index 7c7cb29e4600c91b739cca19caaa95bf67fbfb50..0290a93f86284295682ad7def6c2fc627ba7da59 100644 --- a/hugo/content/installation/py/_index.md +++ b/hugo/content/deploy/py/_index.md @@ -11,7 +11,7 @@ The only exception is if BornAgain has been specially built with the flag `BORNAGAIN_PYTHON=OFF`, which results in a GUI app that has no support for import or export of Python scripts. -Therefore, before [installing](/installation/install) or [building](/installation/building) +Therefore, before [installing](/deploy/install) or [building](/deploy/building) BornAgain, install Python following these operating-system specific instructions: * [Python on Linux](linux) diff --git a/hugo/content/installation/py/linux.md b/hugo/content/deploy/py/linux.md similarity index 98% rename from hugo/content/installation/py/linux.md rename to hugo/content/deploy/py/linux.md index 0e8a9bb9f2695488e9161965a8567187a3ac50a2..e2cad8ba849ba8ab7bd4eaa9360b554dd689536a 100644 --- a/hugo/content/installation/py/linux.md +++ b/hugo/content/deploy/py/linux.md @@ -61,4 +61,4 @@ which python # shows path in virtual environment # install Python modules pip install numpy matplotlib corner emcee lmfit scipy tqdm wheel auditwheel setuptools ``` -For explanations, see the page on required or recommended [modules](/installation/py/modules/). +For explanations, see the page on required or recommended [modules](/deploy/py/modules/). diff --git a/hugo/content/installation/py/mac.md b/hugo/content/deploy/py/mac.md similarity index 100% rename from hugo/content/installation/py/mac.md rename to hugo/content/deploy/py/mac.md diff --git a/hugo/content/installation/py/modules.md b/hugo/content/deploy/py/modules.md similarity index 100% rename from hugo/content/installation/py/modules.md rename to hugo/content/deploy/py/modules.md diff --git a/hugo/content/installation/py/win.md b/hugo/content/deploy/py/win.md similarity index 100% rename from hugo/content/installation/py/win.md rename to hugo/content/deploy/py/win.md diff --git a/hugo/content/howto/troubleshooting/index.md b/hugo/content/howto/troubleshooting/index.md index 5f0fa9c5b142584a207e968e09c91184225b08ce..259e01b2223acd6ec2c29300fcfbec379e35ee3a 100644 --- a/hugo/content/howto/troubleshooting/index.md +++ b/hugo/content/howto/troubleshooting/index.md @@ -120,7 +120,7 @@ CMake Error at GUI/CMakeLists.txt:18 (find_package): The error message can also complain about "Qt5Widgets" instead of "Qt5Designer". -First, make sure that all Qt5 libraries are installed as required in the [build instructions]({{% relref "installation/building/unix" %}}). +First, make sure that all Qt5 libraries are installed as required in the [build instructions]({{% relref "deploy/building/unix" %}}). If this is the case, a first possible cause for this to happen, is that `cmake` cannot find the cmake config files for the required Qt5 modules, because it doesn't know the location. This can be fixed by adding the path to the Qt5 binaries to the `PATH` environment variable: diff --git a/hugo/content/installation/install/_index.md b/hugo/content/installation/install/_index.md deleted file mode 100644 index 8efab15989c072be2d8865532077194460a38e93..0000000000000000000000000000000000000000 --- a/hugo/content/installation/install/_index.md +++ /dev/null @@ -1,10 +0,0 @@ -+++ -title = "Install BornAgain" -weight = 10 -+++ - -## Installing BornAgain - -Here are the platform specific instructions to install BornAgain as a binary. - -{{% children %}} diff --git a/hugo/content/py/_index.md b/hugo/content/py/_index.md index 3add083a4763e22b9a2569e023dfe24878b0cb1d..777b74fffd228d6cf25dcbd7979183794da8496b 100644 --- a/hugo/content/py/_index.md +++ b/hugo/content/py/_index.md @@ -27,7 +27,7 @@ one can ##### Install Install Python and the BornAgain Python module as explained in the -[installation instructions]({{% relref "installation" %}}). +[installation instructions]({{% relref "deploy" %}}). ##### Check installation diff --git a/hugo/content/py/run.md b/hugo/content/py/run.md index 0cc93868c7d27300b49b3b6a8b607e2cb3eca9df..0bb485e57ed6886ce74e9b48dab3f2a059bfd5ab 100644 --- a/hugo/content/py/run.md +++ b/hugo/content/py/run.md @@ -8,7 +8,7 @@ weight = 10 To get started with BornAgain scripting, run a first example. We assume that BornAgain and Python are -[installed]({{% relref "installation" %}}) +[installed]({{% relref "deploy" %}}) and that the Python interpreter can `import bornagain` (see [preceding page](/py), "Check Installation"). diff --git a/hugo/static/css/theme.css b/hugo/static/css/theme.css index 027a44c35796626f9581dd93baf4aebc9cdedd94..29d6a83de93f0d9ccd685d9089ca520e6c2c8723 100644 --- a/hugo/static/css/theme.css +++ b/hugo/static/css/theme.css @@ -311,6 +311,10 @@ figure.float-left { margin: 0rem 0rem 0.5rem 0rem; } +figure.inline { + text-align: inline-block; +} + /* ------------------------------------------------------------- * * Tuning custom figscg and galleryscg shortcodes /* ------------------------------------------------------------- */ diff --git a/hugo/static/img/job_artifacts.png b/hugo/static/img/job_artifacts.png new file mode 100644 index 0000000000000000000000000000000000000000..e969fb8f017fb3018443e4b30cd431068f5d5949 Binary files /dev/null and b/hugo/static/img/job_artifacts.png differ diff --git a/hugo/static/img/job_tag_main.png b/hugo/static/img/job_tag_main.png new file mode 100644 index 0000000000000000000000000000000000000000..8fb401abb9325ba0bc5127b3d37751622bc55a48 Binary files /dev/null and b/hugo/static/img/job_tag_main.png differ diff --git a/hugo/static/img/job_tag_passed.png b/hugo/static/img/job_tag_passed.png new file mode 100644 index 0000000000000000000000000000000000000000..9c55067de385bb08fc46c94f7204beb893b0c628 Binary files /dev/null and b/hugo/static/img/job_tag_passed.png differ diff --git a/hugo/static/img/job_tag_win.png b/hugo/static/img/job_tag_win.png new file mode 100644 index 0000000000000000000000000000000000000000..fc23f8632e18abd6a1f51c654e49d91cbe6fef2b Binary files /dev/null and b/hugo/static/img/job_tag_win.png differ diff --git a/hugo/static/img/job_win_main.png b/hugo/static/img/job_win_main.png new file mode 100644 index 0000000000000000000000000000000000000000..df99464fcfd1e420a3ac348a68db821e35cb1258 Binary files /dev/null and b/hugo/static/img/job_win_main.png differ