Merge pull request #1 from ukaea/release/2.6.0

Release/2.6.0

Author: jholloc

CMakeLists.txt

@@ -47,7 +47,7 @@ include( GetGitRevisionDescription )
 git_describe( GIT_TAG --tags )
 
 if( "${GIT_TAG}" MATCHES "^.*NOTFOUND$" )
-  message( "Failed to get git revision: ${GIT_TAG}" )
+  message( WARNING "Failed to get git revision: ${GIT_TAG}" )
   set( GIT_VERSION "0.0.0" )
 elseif( "${GIT_TAG}" MATCHES "^([0-9]+\\.[0-9]+\\.[0-9]+)$" )
   set( GIT_VERSION "${GIT_TAG}" )
@@ -184,6 +184,9 @@ if( BUILD_SHARED_LIBS )
   message( "Build shared libraries asked" )
 endif()
 
+# Server config options
+set (UDA_SERVER_PORT "56565" CACHE string "define port number in server configuration files")
+set (UDA_SERVER_HOST "`hostname`" CACHE string "define hostname in server configuration files")
 ########################################################################################################################
 # Source directories
 
@@ -232,11 +235,15 @@ include( InstallRequiredSystemLibraries )
 
 set( CPACK_PACKAGE_DESCRIPTION_SUMMARY "Universal Data Access library" )
 set( CPACK_PACKAGE_VENDOR "ITER" )
+set( CPACK_PACKAGE_CONTACT "jonathan.hollocombe@ukaea.uk" )
 set( CPACK_PACKAGE_VERSION_MAJOR "${PROJECT_VERSION_MAJOR}" )
 set( CPACK_PACKAGE_VERSION_MINOR "${PROJECT_VERSION_MINOR}" )
 set( CPACK_PACKAGE_VERSION_PATCH "${PROJECT_VERSION_PATCH}" )
 set( CPACK_PACKAGE_INSTALL_DIRECTORY "uda-${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}" )
 set( CPACK_PACKAGE_FILE_NAME "uda-install-${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}.${PROJECT_VERSION_PATCH}" )
+set( CPACK_BUNDLE_NAME uda )
+set( CPACK_BUNDLE_PLIST ${CMAKE_SOURCE_DIR}/Info.plist )
+set( CPACK_BUNDLE_ICON ${CMAKE_SOURCE_DIR}/cmake/uda.icns )
 if( WIN32 OR MINGW )
   set( CMAKE_WIN_CURRENT_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR} )
   set( CMAKE_WIN_INSTALL_PREFIX ${CMAKE_INSTALL_PREFIX} )
@@ -275,6 +282,14 @@ else()
   set( CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENCE.txt" )
   set( CPACK_STRIP_FILES "bin/uda_server" )
   set( CPACK_SOURCE_STRIP_FILES "" )
+
+  set( CPACK_RPM_PACKAGE_NAME "uda" )
+  set( CPACK_RPM_PACKAGE_SUMMARY "UDA RPM package" )
+  set( CPACK_RPM_FILE_NAME RPM-DEFAULT )
+  set( CPACK_RPM_PACKAGE_VERSION CPACK_PACKAGE_VERSION )
+  set( CPACK_RPM_PACKAGE_ARCHITECTURE noarch )
+  set( CPACK_RPM_PACKAGE_RELEASE 1 )
+  set( CPACK_RPM_PACKAGE_LICENSE "Apache, version 2" )
 endif()
 set( CPACK_PACKAGE_EXECUTABLES "uda_server" "UDA Server" )
 

cmake/icon.bmp

@@ -0,0 +1,3 @@
+Gemfile.lock
+.jekyll-cache
+_site

docs/.gitignore

@@ -0,0 +1,11 @@
+---
+layout: default
+title: 404
+permalink: /404
+nav_exclude: true
+search_exclude: true
+---
+
+<h1>Page not found</h1>
+
+<p>The page you requested could not be found. Try using the navigation {% if site.search_enabled != false %}or search {% endif %}to find what you're looking for or go to this <a href="{{ '/' | relative_url }}">site's home page</a>.</p>

docs/404.md

@@ -0,0 +1,15 @@
+source "https://rubygems.org"
+
+gem "jekyll", "~> 4.1"
+gem "jekyll-sitemap", "~> 1.4.0"
+gem "jekyll-mentions", "~> 1.6.0"
+gem "jekyll-paginate", "~> 1.1.0"
+gem "jekyll-seo-tag", "~> 2.6.1"
+gem "jekyll-redirect-from", "~> 0.16"
+gem "jekyll-feed", "~> 0.15"
+gem "jekyll-commonmark", "~> 1.3.1"
+gem "jekyll-include-cache", "~> 0.2"
+gem "jemoji", "~> 0.12"
+gem "jekyll-remote-theme", "~> 0.3"
+gem "webrick", "~> 1.7"
+gem "rake", "~> 13.0"

docs/Gemfile

@@ -0,0 +1,9 @@
+# Starter kit for [Alembic](https://alembic.darn.es/)
+
+This is a very simple starting point if you wish to use Alembic [as a Jekyll theme gem](https://alembic.darn.es/#as-a-jekyll-theme) or as a [GitHub Pages remote theme](https://github.com/daviddarnes/alembic-kit/tree/remote-theme) (see `remote-theme` branch).
+
+[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/daviddarnes/alembic-kit)
+
+or
+
+**[Download the GitHub Pages kit](https://github.com/daviddarnes/alembic-kit/archive/remote-theme.zip)**

docs/README.md

@@ -0,0 +1,138 @@
+# Set theme
+remote_theme: just-the-docs/just-the-docs@main
+
+# File excludes
+exclude:
+- README.md
+- Gemfile
+- Gemfile.lock
+- .jekyll-cache
+- .sass-cache
+
+# Set a path/url to a logo that will be displayed instead of the title
+logo: "/assets/images/uda_logo.svg"
+
+# Enable or disable the site search
+# Supports true (default) or false
+search_enabled: true
+search:
+  # Split pages into sections that can be searched individually
+  # Supports 1 - 6, default: 2
+  heading_level: 2
+  # Maximum amount of previews per search result
+  # Default: 3
+  previews: 2
+  # Maximum amount of words to display before a matched word in the preview
+  # Default: 5
+  preview_words_before: 3
+  # Maximum amount of words to display after a matched word in the preview
+  # Default: 10
+  preview_words_after: 3
+  # Set the search token separator
+  # Default: /[\s\-/]+/
+  # Example: enable support for hyphenated search words
+  tokenizer_separator: /[\s/]+/
+  # Display the relative url in search results
+  # Supports true (default) or false
+  rel_url: true
+  # Enable or disable the search button that appears in the bottom right corner of every page
+  # Supports true or false (default)
+  button: false
+
+# Enable or disable heading anchors
+heading_anchors: true
+
+# Aux links for the upper right navigation
+aux_links:
+  "UDA on GitHub":
+    - "https://github.com/ukaea/uda"
+
+# Makes Aux links open in a new tab. Default is false
+aux_links_new_tab: false
+
+# Sort order for navigation links
+# nav_sort: case_insensitive # default, equivalent to nil
+nav_sort: case_sensitive # Capital letters sorted before lowercase
+
+# External navigation links
+nav_external_links:
+  - title: UDA on GitHub
+    url: https://github.com/ukaea/uda
+
+# Back to top link
+back_to_top: true
+back_to_top_text: "Back to top"
+
+# Footer last edited timestamp
+last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
+last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html
+
+# Footer "Edit this page on GitHub" link text
+gh_edit_link: true # show or hide edit this page link
+gh_edit_link_text: "Edit this page on GitHub"
+gh_edit_repository: "https://github.com/ukaea/uda" # the github URL for your repo
+gh_edit_branch: "docs" # the branch that your docs is served from
+gh_edit_source: docs # the source that your files originate from
+gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
+
+# Color scheme currently only supports "dark", "light"/nil (default), or a custom scheme that you define
+color_scheme: light
+
+callouts_level: quiet # or loud
+callouts:
+  highlight:
+    color: yellow
+  important:
+    title: Important
+    color: blue
+  new:
+    title: New
+    color: green
+  note:
+    title: Note
+    color: purple
+  warning:
+    title: Warning
+    color: red
+
+plugins:
+  - jekyll-sitemap
+  - jekyll-mentions
+  - jekyll-paginate
+  - jekyll-seo-tag
+  - jekyll-redirect-from
+  - jekyll-feed
+  - jekyll-commonmark
+  - jekyll-include-cache
+  - jemoji
+  - jekyll-remote-theme
+
+kramdown:
+  syntax_highlighter_opts:
+    block:
+      line_numbers: false
+
+compress_html:
+  clippings: all
+  comments: all
+  endings: all
+  startings: []
+  blanklines: false
+  profile: false
+  # ignore:
+  #   envs: all
+
+# Site settings
+url: 'https://ukaea.github.io/UDA/'
+baseurl: '/UDA'
+title: 'UDA'
+description: 'UDA documentation'
+permalink: pretty
+encoding: utf-8 # Make sure the encoding is right
+lang: en-GB # Set the site language
+repo: "https://github.com/ukaea/UDA"
+email: "jonathan.hollocombe@ukaea.uk"
+
+favicons: # Favicons are also used in the manifest file. Syntax is 'size: path'
+  16: '/assets/logos/favicon-16x16.png'
+  32: '/assets/logos/favicon-32x32.png'

docs/UDA architecture.svg

@@ -0,0 +1 @@
+<link rel="shortcut icon" type="image/png" href="/UDA/assets/logos/favicon-32x32.png">