diff --git a/Gemfile.lock b/Gemfile.lock index c3969efc..7b3021f1 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -22,7 +22,7 @@ GEM ffi (1.9.14-x64-mingw32) forwardable-extended (2.6.0) gemoji (2.1.0) - github-pages (99) + github-pages (100) activesupport (= 4.2.7) github-pages-health-check (= 1.2.0) jekyll (= 3.2.1) @@ -35,7 +35,7 @@ GEM jekyll-redirect-from (= 0.11.0) jekyll-sass-converter (= 1.3.0) jekyll-seo-tag (= 2.0.0) - jekyll-sitemap (= 0.10.0) + jekyll-sitemap (= 0.11.0) jekyll-swiss (= 0.4.0) jemoji (= 0.7.0) kramdown (= 1.11.1) @@ -77,9 +77,9 @@ GEM activesupport (~> 4.0) html-pipeline (~> 2.3) jekyll (~> 3.0) - jekyll-octicons (2.1.0) + jekyll-octicons (3.0.1) jekyll (~> 3.1) - octicons (~> 2.0) + octicons (~> 3.0) jekyll-paginate (1.1.0) jekyll-redirect-from (0.11.0) jekyll (>= 2.0) @@ -87,7 +87,8 @@ GEM sass (~> 3.2) jekyll-seo-tag (2.0.0) jekyll (~> 3.1) - jekyll-sitemap (0.10.0) + jekyll-sitemap (0.11.0) + addressable (~> 2.4.0) jekyll-swiss (0.4.0) jekyll-watch (1.5.0) listen (~> 3.0, < 3.1) @@ -112,7 +113,7 @@ GEM mini_portile2 (~> 2.1.0) nokogiri (1.6.8.1-x64-mingw32) mini_portile2 (~> 2.1.0) - octicons (2.1.0) + octicons (3.0.1) nokogiri (>= 1.6.3.1) octokit (4.4.1) sawyer (~> 0.7.0, >= 0.5.3) diff --git a/Gemfile~ b/Gemfile~ deleted file mode 100644 index 6c08bcf0..00000000 --- a/Gemfile~ +++ /dev/null @@ -1,24 +0,0 @@ -source "https://rubygems.org" - -# Hello! This is where you manage which Jekyll version is used to run. -# When you want to use a different version, change it below, save the -# file and run `bundle install`. Run Jekyll with `bundle exec`, like so: -# -# bundle exec jekyll serve -# -# This will help ensure the proper Jekyll version is running. -# Happy Jekylling! - -gem "github-pages", group: :jekyll_plugins - -# If you want to use Jekyll native, uncomment the line below. -# To upgrade, run `bundle update`. - -# gem "jekyll" - -gem "wdm", "~> 0.1.0" if Gem.win_platform? - -# If you have any plugins, put them here! -group :jekyll_plugins do - # gem "jekyll-archives" -end \ No newline at end of file diff --git a/_config.yml b/_config.yml index a980e035..79c088a0 100644 --- a/_config.yml +++ b/_config.yml @@ -11,8 +11,8 @@ title : "GRID" title_separator : "|" name : "Our team" description : "Data parallel C++ mathematical object library." -url : "https://paboyle.github.io/" # the base hostname & protocol for your site e.g. "https://mmistakes.github.io" -baseurl : # the subpath of your site, e.g. "/blog" +url : 'https://paboyle.github.io' # the base hostname & protocol for your site e.g. "https://mmistakes.github.io" +baseurl : '/Grid' # the subpath of your site, e.g. "/blog" repository : "paboyle/Grid" teaser : # filename of teaser fallback teaser image placed in /images/, .e.g. "500x300.png" # breadcrumbs : false # true, false (default) @@ -144,7 +144,7 @@ markdown_ext: "markdown,mkdown,mkdn,mkd,md" # Conversion markdown: kramdown -highlighter: rouge +highlighter: pygments lsi: false excerpt_separator: "\n\n" incremental: false diff --git a/_config_local.yml b/_config_local.yml new file mode 100644 index 00000000..f4a53a89 --- /dev/null +++ b/_config_local.yml @@ -0,0 +1,231 @@ +# Welcome to Jekyll! +# +# This config file is meant for settings that affect your entire site, values +# which you are expected to set up once and rarely need to edit after that. +# For technical reasons, this file is *NOT* reloaded automatically when you use +# `jekyll serve`. If you change this file, please restart the server process. + +# Site Settings +locale : "en" +title : "GRID" +title_separator : "|" +name : "Our team" +description : "Data parallel C++ mathematical object library." +url : 'http://127.0.0.1:4000' # the base hostname & protocol for your site e.g. "https://mmistakes.github.io" +baseurl : '/Grid' # the subpath of your site, e.g. "/blog" +repository : "paboyle/Grid" +teaser : # filename of teaser fallback teaser image placed in /images/, .e.g. "500x300.png" +# breadcrumbs : false # true, false (default) +words_per_minute : 200 +comments: + provider : # false (default), "disqus", "discourse", "facebook", "google-plus", "staticman", "custom" + disqus: + shortname : # https://help.disqus.com/customer/portal/articles/466208-what-s-a-shortname- + discourse: + server : # https://meta.discourse.org/t/embedding-discourse-comments-via-javascript/31963 , e.g.: meta.discourse.org + facebook: + # https://developers.facebook.com/docs/plugins/comments + appid : + num_posts : # 5 (default) + colorscheme : # "light" (default), "dark" +staticman: + allowedFields : ['name', 'email', 'url', 'message'] + branch : # "master", "gh-pages" + commitMessage : "New comment." + filename : comment-{@timestamp} + format : "yml" + moderation : true + path : "_data/comments/{options.slug}" + requiredFields : ['name', 'email', 'message'] + transforms: + email : "md5" + generatedFields: + date: + type : "date" + options: + format : "iso8601" # "iso8601" (default), "timestamp-seconds", "timestamp-milliseconds" +atom_feed: + path : # blank (default) uses feed.xml + +# SEO Related +google_site_verification : +bing_site_verification : +alexa_site_verification : +yandex_site_verification : + +# Social Sharing +twitter: + username : +facebook: + username : + app_id : + publisher : +og_image : # Open Graph/Twitter default site image +# For specifying social profiles +# - https://developers.google.com/structured-data/customize/social-profiles +social: + type : # Person or Organization (defaults to Person) + name : # If the user or organization name differs from the site's name + links: # An array of links to social media profiles + +# Analytics +analytics: + provider : false # false (default), "google", "google-universal", "custom" + google: + tracking_id : + + +# Site Author +author: + name : "PPT Group" + avatar : "bio-photo.jpg" + bio : "Our group is amazing." + location : "Edinburgh" + email : "guido.cossu@ed.ac.uk" + uri : + bitbucket : + codepen : + dribbble : + flickr : + facebook : + foursquare : + github : + google_plus : + keybase : + instagram : + lastfm : + linkedin : + pinterest : + soundcloud : + stackoverflow : # "123456/username" (the last part of your profile url, e.g. http://stackoverflow.com/users/123456/username) + steam : + tumblr : + twitter : + vine : + weibo : + xing : + youtube : + + +# Reading Files +include: + - .htaccess + - _pages +exclude: + - "*.sublime-project" + - "*.sublime-workspace" + - vendor + - .asset-cache + - .bundle + - .jekyll-assets-cache + - .sass-cache + - assets/js/plugins + - assets/js/_main.js + - assets/js/vendor + - Capfile + - CHANGELOG + - config + - Gemfile + - Gruntfile.js + - gulpfile.js + - LICENSE + - log + - node_modules + - package.json + - Rakefile + - README + - tmp +keep_files: + - .git + - .svn +encoding: "utf-8" +markdown_ext: "markdown,mkdown,mkdn,mkd,md" + + +# Conversion +markdown: kramdown +highlighter: pygments +lsi: false +excerpt_separator: "\n\n" +incremental: false + + +# Markdown Processing +kramdown: + input: GFM + hard_wrap: false + auto_ids: true + footnote_nr: 1 + entity_output: as_char + toc_levels: 1..6 + smart_quotes: lsquo,rsquo,ldquo,rdquo + enable_coderay: false + + +# Sass/SCSS +sass: + sass_dir: _sass + style: compressed # http://sass-lang.com/documentation/file.SASS_REFERENCE.html#output_style + + +# Outputting +permalink: /:categories/:title/ +paginate: 5 # amount of posts to show +paginate_path: /page:num/ +timezone: # http://en.wikipedia.org/wiki/List_of_tz_database_time_zones + + +# Plugins +gems: + - jekyll-paginate + - jekyll-sitemap + - jekyll-gist + - jekyll-feed + - jekyll-octicons + - jemoji + +# mimic GitHub Pages with --safe +whitelist: + - jekyll-paginate + - jekyll-sitemap + - jekyll-gist + - jekyll-feed + - jekyll-octicons + - jemoji + + +# Archives +# Type +# - GitHub Pages compatible archive pages built with Liquid ~> type: liquid (default) +# - Jekyll Archives plugin archive pages ~> type: jekyll-archives +# Path (examples) +# - Archive page should exist at path when using Liquid method or you can +# expect broken links (especially with breadcrumbs enabled) +# - /tags/my-awesome-tag/index.html ~> path: /tags/ +# - path: /categories/ +# - path: / +category_archive: + type: liquid + path: /categories/ +tag_archive: + type: liquid + path: /tags/ +# https://github.com/jekyll/jekyll-archives +# jekyll-archives: +# enabled: +# - categories +# - tags +# layouts: +# category: archive-taxonomy +# tag: archive-taxonomy +# permalinks: +# category: /categories/:name/ +# tag: /tags/:name/ + + +# HTML Compression +# - http://jch.penibelst.de/ +compress_html: + clippings: all + ignore: + envs: development \ No newline at end of file diff --git a/_pages/quick-start-guide.md b/_pages/quick-start-guide.md index c49afb9e..6c5927fb 100644 --- a/_pages/quick-start-guide.md +++ b/_pages/quick-start-guide.md @@ -21,27 +21,61 @@ cd Grid ./bootstrap.sh ``` -Now you can execute the `configure` script to generate makefiles (here from a build directory): +Now you can execute the `configure` script to generate makefiles as in this example (here from a build directory): ``` bash mkdir build; cd build ../configure --enable-precision=double --enable-simd=AVX --enable-comms=mpi-auto --prefix= ``` -where `--enable-precision=` set the default precision (`single` or `double`), -`--enable-simd=` set the SIMD type (see possible values below), `--enable- -comms=` set the protocol used for communications (`none`, `mpi`, `mpi-auto` or -`shmem`), and `` should be replaced by the prefix path where you want to -install Grid. The `mpi-auto` communication option set `configure` to determine -automatically how to link to MPI. Other options are available, use `configure ---help` to display them. Like with any other program using GNU autotool, the -`CXX`, `CXXFLAGS`, `LDFLAGS`, ... environment variables can be modified to +The list of possible options from the `./configure --help` command is + +``` text +Optional Features: + --disable-option-checking ignore unrecognized --enable/--with options + --disable-FEATURE do not include FEATURE (same as --enable-FEATURE=no) + --enable-FEATURE[=ARG] include FEATURE [ARG=yes] + --enable-silent-rules less verbose build output (undo: "make V=1") + --disable-silent-rules verbose build output (undo: "make V=0") + --enable-dependency-tracking + do not reject slow dependency extractors + --disable-dependency-tracking + speeds up one-time build + --disable-openmp do not use OpenMP + --enable-lapack=yes|no|prefix + enable LAPACK + --enable-numa=yes|no|prefix + enable first touch numa opt + --enable-simd=SSE4|AVX|AVXFMA4|AVXFMA|AVX2|AVX512|AVX512MIC|IMCI|KNL|KNC + Select instructions to be SSE4.0, AVX 1.0, AVX + 2.0+FMA, AVX 512, IMCI + --enable-precision=single|double + Select default word size of Real + --enable-comms=none|mpi|mpi-auto|shmem + Select communications + --enable-rng=ranlux48|mt19937 + Select Random Number Generator to be used + --enable-timers Enable system dependent high res timers + --enable-chroma Expect chroma compiled under c++11 + --enable-doxygen enable documentation generation with doxygen (auto) + --enable-dot use 'dot' to generate graphs in doxygen (auto) + --enable-html-docs enable HTML generation with doxygen (yes) + --enable-latex-docs enable LaTeX documentation generation with doxygen + (no) +``` + + +and `` should be replaced by the prefix path where you want to +install Grid. The `mpi-auto` communication option let `configure` to determine +automatically how to link to MPI. +Like with any other program using GNU autotool, the `CXX`, `CXXFLAGS`, `LDFLAGS`, ... environment variables can be modified to customise the build. Finally, you can build and install Grid: ``` bash -make; make install +make +make install ``` To minimise the build time, only the tests at the root of the `tests` directory are built by default. If you want to build tests in the sub-directory `` you can execute: