From 500a2da0ed911165977d468c7b6c66031a5c8a13 Mon Sep 17 00:00:00 2001 From: Whitney Armstrong <warmstrong@anl.gov> Date: Sat, 21 Mar 2020 22:26:22 -0500 Subject: [PATCH] iinit --- gatsby-config.js | 2 +- .../gatsby-theme-docs/.../theme.js | 14 + .../gatsby-theme-docs/components/Logo.js | 10 + .../gatsby-theme-docs/styles/global.js | 270 ++++++++++++++++++ .../gatsby-theme-docs/styles/theme.js | 14 + src/config/sidebar.yml | 22 +- src/docs/anl_eic_logo_3.png | Bin 0 -> 7569 bytes src/docs/codeblock.md | 26 ++ src/docs/codeblock/1-index.md | 26 ++ src/docs/codeblock/1-index/1-index.md | 33 +++ src/docs/getting-started/eic_container.md | 18 ++ src/docs/getting-started/environment.md | 24 ++ src/docs/getting-started/modulefiles.md | 24 ++ src/docs/getting-started/quickstart.md | 25 ++ src/docs/getting-started/singularity.md | 31 ++ ...ting-started.mdx => gettingstartedold.mdx} | 0 src/docs/hackathon.md | 7 + src/docs/hackathon/1-tasks.md | 7 + src/docs/index.mdx | 45 +++ src/docs/introduction.mdx | 60 ++++ src/docs/part1.md | 9 + src/docs/part1/simple_detector.md | 24 ++ src/docs/part2.md | 8 + 23 files changed, 695 insertions(+), 4 deletions(-) create mode 100644 src/@rocketseat/gatsby-theme-docs/.../theme.js create mode 100644 src/@rocketseat/gatsby-theme-docs/components/Logo.js create mode 100644 src/@rocketseat/gatsby-theme-docs/styles/global.js create mode 100644 src/@rocketseat/gatsby-theme-docs/styles/theme.js create mode 100644 src/docs/anl_eic_logo_3.png create mode 100644 src/docs/codeblock.md create mode 100644 src/docs/codeblock/1-index.md create mode 100644 src/docs/codeblock/1-index/1-index.md create mode 100644 src/docs/getting-started/eic_container.md create mode 100644 src/docs/getting-started/environment.md create mode 100644 src/docs/getting-started/modulefiles.md create mode 100644 src/docs/getting-started/quickstart.md create mode 100644 src/docs/getting-started/singularity.md rename src/docs/{getting-started.mdx => gettingstartedold.mdx} (100%) create mode 100644 src/docs/hackathon.md create mode 100644 src/docs/hackathon/1-tasks.md create mode 100644 src/docs/index.mdx create mode 100644 src/docs/introduction.mdx create mode 100644 src/docs/part1.md create mode 100644 src/docs/part1/simple_detector.md create mode 100644 src/docs/part2.md diff --git a/gatsby-config.js b/gatsby-config.js index 559588e..e13f161 100644 --- a/gatsby-config.js +++ b/gatsby-config.js @@ -8,7 +8,7 @@ module.exports = { siteAuthor: `@rocketseat`, siteImage: `/banner.png`, siteLanguage: `en`, - themeColor: `#7159c1`, + themeColor: `#e1a809`, basePath: `/`, footer: `Theme by Rocketseat`, }, diff --git a/src/@rocketseat/gatsby-theme-docs/.../theme.js b/src/@rocketseat/gatsby-theme-docs/.../theme.js new file mode 100644 index 0000000..4353bde --- /dev/null +++ b/src/@rocketseat/gatsby-theme-docs/.../theme.js @@ -0,0 +1,14 @@ +export default { + colors: { + primary: '#E1A809', + background: '#fff', + sidebar: { + background: '#ffffff', + link: '#999', + heading: '#aaa', + linkActive: '#13131A', + itemActive: '#F5F5FA', + footer: '#A8A8B3', + }, + }, +}; diff --git a/src/@rocketseat/gatsby-theme-docs/components/Logo.js b/src/@rocketseat/gatsby-theme-docs/components/Logo.js new file mode 100644 index 0000000..a366254 --- /dev/null +++ b/src/@rocketseat/gatsby-theme-docs/components/Logo.js @@ -0,0 +1,10 @@ +import styled from '@emotion/styled'; + +import logo from '../../../docs/anl_eic_logo_3.png'; + +export default styled.div` + width: 260px; + height: 90px; + background-size: contain; + background: url(${logo}) center no-repeat; +`; diff --git a/src/@rocketseat/gatsby-theme-docs/styles/global.js b/src/@rocketseat/gatsby-theme-docs/styles/global.js new file mode 100644 index 0000000..1b43e4e --- /dev/null +++ b/src/@rocketseat/gatsby-theme-docs/styles/global.js @@ -0,0 +1,270 @@ +import React from 'react'; +import { Global, css } from '@emotion/core'; +import { useTheme } from 'emotion-theming'; +import { lighten } from 'polished'; + +export default function GlobalStyle() { + const theme = useTheme(); + + return ( + <Global + styles={css` + @import url('https://fonts.googleapis.com/css?family=Roboto&display=swap'); + @import url('https://fonts.googleapis.com/css?family=Roboto:300,400,500,700&display=swap'); + @import url('https://fonts.googleapis.com/css?family=Poppins:300,400,500,600&display=swap'); + *, + *::after, + *::before { + margin: 0; + padding: 0; + box-sizing: border-box; + } + + *::selection { + background: ${lighten('0.35', '#737380')}!important; + } + + body { + font-size: 16px; + font-family: 'Roboto', sans-serif; + background-color: ${theme.colors.background}; + text-rendering: optimizelegibility; + } + + h1 { + font-size: 32px; + color: #333; + font-weight: normal; + margin-bottom: 24px; + } + + h2 { + font-size: 24px; + padding-bottom: 8px; + border-bottom: 1px solid #eee; + } + + h3 { + font-size: 18px; + } + + h4 { + font-size: 16px; + } + + h2, + h3, + h4, + h5, + h6 { + color: #737380; + margin: 24px 0 16px 0; + font-weight: normal; + } + + p { + color: #737380; + font-size: 16px; + line-height: 28px; + margin-bottom: 16px; + font-weight: 400; + } + + code.inline-code { + display: inline-block; + vertical-align: middle; + line-height: 1; + padding: 0.2em 0.2em 0.3em 0.2em; + background-color: #44475a; + color: rgba(248, 248, 242); + font-size: 14px; + border-radius: 3px; + font-feature-settings: 'clig' 0, 'calt' 0; + font-variant: no-common-ligatures no-discretionary-ligatures + no-historical-ligatures no-contextual; + } + + a { + color: #737380; + font-weight: bold; + + &:hover { + color: ${theme.colors.primary}!important; + transition: all 100ms cubic-bezier(0.4, 0, 0.2, 1) 0s; + opacity: 1 !important; + } + } + + blockquote { + border-left: 4px solid #e7e7e7; + padding: 0 2rem; + + p { + font-style: italic !important; + font-size: 0.88em !important; + line-height: 28px; + } + } + + table { + border-collapse: collapse; + border-spacing: 0; + width: 100%; + margin-bottom: 16px; + color: #444; + } + + th, + td { + text-align: left; + padding: 12px; + } + + tr:nth-of-type(2n) td { + background-color: ${theme.colors.sidebar.itemActive}; + } + + tr { + background-color: #ffffff; + } + + iframe { + margin-bottom: 16px; + } + + ul, + ol { + color: #737380; + padding-left: 15px; + margin-bottom: 16px; + + li { + line-height: 28px; + } + } + + .gatsby-highlight { + position: relative; + + .token { + font-style: normal !important; + } + } + + pre[class*='language-']::before { + background: #d9d7e0; + border-radius: 0 0 4px 4px; + color: #232129; + font-size: 12px; + font-family: SFMono-Regular, Menlo, Monaco, Consolas, + 'Liberation Mono', 'Courier New', monospace; + letter-spacing: 0.075em; + line-height: 1; + padding: 0.25rem 0.5rem; + position: absolute; + left: 1rem; + text-align: right; + text-transform: uppercase; + top: 0; + } + + pre[class*='language-'] code { + font-family: SFMono-Regular, Menlo, Monaco, Consolas, + 'Liberation Mono', 'Courier New', monospace; + font-variant: no-common-ligatures no-discretionary-ligatures + no-historical-ligatures no-contextual; + } + + pre[class~='language-js']::before, + pre[class~='language-javascript']::before { + content: 'js'; + background: #f7df1e; + } + + pre[class~='language-jsx']::before { + content: 'jsx'; + background: #61dafb; + } + + pre[class~='language-typescript']::before, + pre[class~='language-ts']::before { + content: 'ts'; + background: #294e80; + color: #fff; + } + + pre[class~='language-tsx']::before { + content: 'tsx'; + background: #294e80; + color: #fff; + } + + pre[class~='language-graphql']::before { + content: 'GraphQL'; + background: #e10098; + color: #fff; + } + + pre[class~='language-html']::before { + content: 'html'; + background: #005a9c; + color: #fff; + } + + pre[class~='language-css']::before { + content: 'css'; + background: #ff9800; + color: #fff; + } + + pre[class~='language-mdx']::before { + content: 'mdx'; + background: #f9ac00; + color: #fff; + } + + pre[class~='language-shell']::before { + content: 'shell'; + } + + pre[class~='language-sh']::before { + content: 'sh'; + } + + pre[class~='language-bash']::before { + content: 'bash'; + } + + pre[class~='language-yaml']::before { + content: 'yaml'; + background: #ffa8df; + } + + pre[class~='language-markdown']::before { + content: 'md'; + } + + pre[class~='language-json']::before, + pre[class~='language-json5']::before { + content: 'json'; + background: linen; + } + + pre[class~='language-diff']::before { + content: 'diff'; + background: #e6ffed; + } + + pre[class~='language-text']::before { + content: 'text'; + background: #fff; + } + + pre[class~='language-flow']::before { + content: 'flow'; + background: #e8bd36; + } + `} + /> + ); +} diff --git a/src/@rocketseat/gatsby-theme-docs/styles/theme.js b/src/@rocketseat/gatsby-theme-docs/styles/theme.js new file mode 100644 index 0000000..4353bde --- /dev/null +++ b/src/@rocketseat/gatsby-theme-docs/styles/theme.js @@ -0,0 +1,14 @@ +export default { + colors: { + primary: '#E1A809', + background: '#fff', + sidebar: { + background: '#ffffff', + link: '#999', + heading: '#aaa', + linkActive: '#13131A', + itemActive: '#F5F5FA', + footer: '#A8A8B3', + }, + }, +}; diff --git a/src/config/sidebar.yml b/src/config/sidebar.yml index efd0731..b17762d 100644 --- a/src/config/sidebar.yml +++ b/src/config/sidebar.yml @@ -1,11 +1,27 @@ # Sidebar navigation -- label: 'Introduction' +- label: 'Home' link: '/' -- label: 'Getting started' - link: '/getting-started' +- label: 'Introduction' + link: '/introduction' +- label: 'Getting really started' + items: + - label: 'Quick-start ' + link: '/getting-started/quickstart' + - label: 'Modulefiles ' + link: '/getting-started/modulefiles' + - label: 'Singularity' + link: '/getting-started/singularity' + - label: 'EIC container' + link: '/getting-started/eic_container' + - label: 'Environment' + link: '/getting-started/environment' +- label: 'Part 1' + items: - label: Usage items: + - label: 'doc Getting started' + link: '/gettingstartedold' - label: 'Creating docs' link: '/usage/creating-docs' - label: 'Navigation' diff --git a/src/docs/anl_eic_logo_3.png b/src/docs/anl_eic_logo_3.png new file mode 100644 index 0000000000000000000000000000000000000000..1fc97dfce8a13e174d96d05e04f26a1cc679c7dd GIT binary patch literal 7569 zcmeAS@N?(olHy`uVBq!ia0y~yU^vCVz!1&B#=yW}6ffn+z`(##?Bp53!NI{%!;#X# zz`(#+;1OBOz`%C|gc+x5^GP!>Fi4iTMwA5Sr<If^7Ns(jmzV2h=4BTrCl;jY<rk&T zerF@az#z-#>EaktG3V{v${8Y8cOI+1YpZ>FLod(jO}sp_4Vt9HL`A=Mc>5eVu6xfz zD0#{Z7k$0JD=Rvq7o}Z|X%6%>Ii@QmuF#>Rut=v%f$6Z)Y93~0p3^*+zxQuHwQk+Z zrK@%=Th9KgcHZZb^3tm-gO{Hx-}kjf-9gN^P5N0t#HJ-ji|5wgetswA`8Oq-y)!Pf z{5vha*3<d&rVWZWuJBsS3Ea{i{q5T-%k60iUmv+Ve=2w{#3zB}iv5Ij+foI4brzZk z=GAt;Yx${p;M(eIPurUx{;GIBO>hlE6q9)EwfYO0FSC-x1XDPdc23~l<sU<@wd= zZ!NM<&xv?0dT=>wi~EfI%nu*rr}arrp1dqAEm6T+!?)q&Wr<k%2TrdyuDZN!+SToA zR&SHzcBsu%khyYwz2Sz>%iaoKx_C}U>4cEitdDP>a|%8yZ+vl(-?3|Z+|Im(Ujwc) zyl+3$$oS3b5M$lWHEY&5E1R2gb8l*yl=db6`1ivGD%a|(PnY%IxnCL2>cCM}&e{I^ z*ve(LPww8!=smNDaZ}4AH=nBBvPOgQqrdHWc1EvTdxJ5+>xVMO6qOb4+)tlk<NvmI zV&oB*Fijs>#RZE4Z!xXaT{`#c_ftFP7<^Fa5)KUu4~eczNO{_`$Wqo#eP{kT@!#L} zGyaji!5Jbw|JwV|17?rQ#WWSXH99ZKz2Gfj-^IY)sCz*9*n1%t1;yK?yBlMt1zp{0 z&m-ZhuWl}D^03<A`O_uOr;3S`*sfo3_vZSL@T-iu4N5L^%C0a-H=I2%{g`o0=AU~E zIV{&0*yn6{U*MwfQ?uP>mqOBu<eG2W{+O}H>Pp4%GoEKGU*Nb+l6TYE18OG4?->q# zo9$CK+x&2W+ooe%PQCx~@x1??k~4q0_5be4IJx|<%$E96zu2=4m!@iekM5i4a+&P~ zLy5D?UEUWgC8l<}6KAYwY(5Z`p!%Wp?dGP#b2|9coith47@ZpzPjsp^k@8u<xKAh| zRrA?<UcGn03?hpecQ9Gh-8pZ$`cKI_kFvxc3SS@hRcYI-`Tug^E8XZHUyf|t!mk#t zJpKLs-#1uA<89d97@qPIf1BHDk)}CI=1fqQ48M|66tfPS7~^`$`Mhc^&Z6zBUR-6e z;QPTQc<4p9%Mz_GlkD04ap|}o37ENHpTMlvex@pci=I|Wi!`?V$xDq1=6>?@$)|#T z$C|^Qi(g;k=jXHjT*A=h<+Z}5Sm*8ifBBbQ_nkSre_gWQyVB^_S!bOSk38L{bm-?Z z=Kbt?#(nt?GAZgGW(K}F!Ctj+-|O~YpM(;uUp<~47_VnyXYUg8V#48thXSn_l^ZV} z&{!aI!j<KN;VjPS67yd_x^huYq9N_FT!%&-;~$Y7e7;)0dtYx?P_0}YxJ~k@_UZcS z2HDBW4K-z+?Mva`u-)p!dA~U4<KOP?w+o98KR(;J{qpOCPo35A7B*Y|eD=?CTd0>S zaB-SM?Pb9TejC0stX9Ggm)vf=>al0lhMM?Zj+N7Hyx{3^uC*1B=;=r|Hju73ui-7= zo^>r_T}x2UlfRb*62Ca=e@RZ@s|tL-*fG1^Q-C>l{@jT&d3+PL9;kI$6P7(e?oq^@ z9jR8TJHM`R_~qoZW%Zs(osXBBSp0i<`TT`f_t@v`Sy50sL6F%#`cvcKXQB#u7md%Q zYhPJ@y3xOJ|AK$H-M<d?2|T)^E|F@YbSX>e{geG2n@z0`W$LvEv9v92w34b|yTQJv zo8yt~k#E^aF}G!R$aE$hp2$(k@Ixk|jji$LPN5Z_S6`fbKg~;Goln`lbG)rK6_ut7 z19Cinv`$nvT5)RPEyMLWKPOFOtS@O-p0LA|L-4@r4rgD-N4J8GEVO5Mw(#GU#Ugvx z3-_M4^Egr~Tp?S*UAU#kT}{|a`@!r3mL1hHjCUAp`s42CB&>h>M<M8fyTT$1z90M_ z%vENeH$RnBqt+4e<7hMwH`|PU=H>4UclI0QohdE+AHTmq@b<BIzlF?4?PNG&3=?iX zS{`e9O?H=}VYY$LPB(?XtwMrlY*g-@bzfGfUB#5X_`4Nb=ka2}i+lKLE_J;1<DBWH z@$*3Bfr<w)CMVLE@+DH2zWsCWz{&#=4^mXZYTa5i(v(gIR|%>W95=b=x;ew?O;oK2 z|K9}POIq<i&Z+YJQkk~zF2n5NS6siRuKS}f*YDW569q<xe#r1WS?KvPckvmfHQt<2 z3(Cv41@^fl-3wW~#w+-?tfDZ7D$AUvHJaiIen!kc*gpteTy}0-$L=0eFMbye;~t~Q zXA+(=s`1X|mYM%yP4mJkzI$RzN|!$|eRtpcp|LS1%WW0wVsFQ|74N@Iy>7nL+)li3 z_T+}kjYePA$vIBG8{MI?M#DWh!A5BMbET$AIZ2;cBEFs)v5oRf;mS9^*Sg63Uy^t{ zhM`7Y@CskTuD~>b`(0PJ%qTfyz@Z|xSL^&Ox9NqP&QWVP&d%MeUSGK*bx|=>%l_Tz zcm3xV-Mg?wp=HO(zZr|9dwNv$7k#(w?}!t1Io9Ca*gZipRch0Xzq8ehSWH+K_Astv zJ?Fmch`qAyA*%<wnZ=cub_%|f-YeK%IX^>e9#@ot`;x0KcTCT?d)!)$x0-8*(zp4t zW|OMZ4G#v)o2|vY{9L@qjd*L5bNA)1uDM+)<MVBGz0VexFr&@$S4~`bXI-;}tGG&D zY|D}Lz6ZEXRA$vY@JSJnY(I8FzM=hNK97adE{>(DQU=$Rir@GwN!ah?vhtjJ%SYQI zmSGDdpBI|^UeaZ>#JI;{+8ntP`vtgfcSamqwpj9P@Al{&Pk#u#dYv@8{qwtd-U}*R z4tEPFN9;^bJ-E8N>cWLc89rf~!uPv6H^*)_mSUcGvX;eY_IH=IDG@iiT~<y#QDP$- z(O~WD$!?NaCoOo^O+@XB_@b|;l^f+1^Gf&%q>C!*UOkGNckxEcB_`WDy&2Eyqy#%c zwQZ#YkEb4cpWgW2xhrAS3+6xkkNo@|Eqk<3?1y;NKI{8er%rCW%X3G%RL7!#)6!nf z=Rov-@jd&V+<kB@R{a*=|Fvm%c|CnE7G4nF!FBdSt<AN>MO?g}j!&3;nb&H;$xmJ` zYm6rz`KWa9$aT4&DQybDpWmLay^xWy=BtM81ovvwMStuUN<NHoQL*%3o7;a#o{h=g zt?KmGC4MUE3fecHA2_?jO-12piOnZT8|NCoD*~*)<&?D6C`b6;Yl&I!!nC3OO~XN! zMLlA>IiKHovv8GgpuH}$+C-~~4NRW-E@7+VFBojH64Vl$IJd##`0@j`8GC#h)-PVa zT{-#SNe`i)429Dd2j|!2{P5NIdB8tF{Vt<TW5jn^kAL}%9FMq79{afat=yOqdvu@3 z`}npuAKxq8G`smZ*Wg?&>q|SoHQLh`?O2xB7iCiUl9B1om#^<HRBq;c{=K{;SEl82 z@vW=h-hbJ8UXkJZwKe<m7I$m?Qe=OmGw17M@h42>3nllvPAX1L)HDz*+->k7R;A0= zb&>G_YY!j!ZngETClo@S?Y+72;qn)yTtQoQDJWHRWCXvR>5*yQ;4<U*$8|inCN`&S zygl*KOb*jyd;j}53#W3N-SmCpnJueL)t4(iHMY!?`=++VX5OFQ{6c)o_TAfS7Zd*D z&7LlY*xD6pJBk&u)vRZxG@Zz-HWzB0yikhwOlC&W?MAi3W*$xwEx-1bPO6&ccu{cW zqY9OUb9&Xb$1B}Eam2F2qJ6=}3TZptsL#y-R*d|MW`46&DVn)Cnz72zvctpAb?&q0 zx7v~(?^|wR@!fgx+>=T%%^frLO@FfI?17CLf+0zFjA{fHO3SH6RBdW5vvTq~x~+BR zX1o7S?`<{T^WwpmvW#uEcMtCTnqjni_7S%pdq(?$0QnX3#Vl;hCEJ*`E8V?(CD6|3 zA2)-z^649nA{S=Wh{h-@b(HjJ9T8fqufR~l?z(WD@ji35UyB*`ZfO3*_Rgh2A?fYO zSGA^3muJ*`aeIHl)Bdg79ec@t#}jMQDo<=*-kHGgsG`)vX~VB2x0vc(j(ig0+M6j9 z({iS{TtN37kNd<$yC)hwceN{RDq0e3QRykKEW9<E$6<5!reBlS#pF1Bah5snY5&%} zZe2=7>yDMuPL;QpKksY}d?6dIq`mrTgMpAF>ncw@#UEXt8`TA`zeu#4*Pik_N+j{t zR>9i=ZB|E5a$7mL{QTTxE^{Z@jq9tqTAx$WhRX;4B)5N!d$q`K^PcC&nN=M)T&qHq zmfp+CImxP~e9l;u{j^+=qrk~EUp3N>zxp86piyOeuB0_2py|vxzxWI5gZAA2E_-LO zoaXkr1st}?`bSLNANFdCFU*Kp{?|nKxz+1ny;r8E?QLzE#Y-IOcG#MjJf7dO<F!#r z?pN7X55-lEn>#xhf~I9ns5B2_6R;O_QA=H}pU%9pyY8>dz1P1~zTWBNk^1ivw&eT8 zGuydz4OaIBzjxfz*{g4nv%Qkv+^!>2@0HnUe;XTTtrzW!X8m{D^6rvg;dZZ-m`}WK zC!E_T`BGjjYQgk4SCfw>YHAPPJ-zenux)dOl1JJ4=R#Kmiz3|DJW{=LXYHcDO{ag| z6*|SJ!nRD>eUZi!-V>dfO8if~Z}gYEopMpEGh}tgw_9ay%l5e?CmIHH$xQN#KWBHR z;(~DU+~(h^MwZieW^CX4=XPqeweWoFquR-__Z}-w|7!nkQ=R=pZkvW<hbvBhWavs; zr=0g-mGKs*D?7T{x_-_NT;qE?B=3Qc-;}KEnXex26}R4TpYc(9cFdDaZ?8QHJ3i~t zrhlP3zMtWDU_Rsd*Sj-iS*F(?hP}$W4?f~cY1nnZd#U1--7mdGnvxbte=t@lQ~liV zyEC}Z{y<IQO168Y73V8t-ei1f`X_FAYM#rpV)fEpGvBs7Ix{C%cl)jt_q(KJ?qu`* zD=f7yU=-TEZmVp)MB$u?dD=A$k-U8yWwQI<T+Dx@ci}Amp61=t_xC?Z6wNa@{;*b7 zC-je0xb>RLkv=m&>^W?;R&}b&{pX7n!mH=bSIkb_b-Yu!hP!ZDx9)MK74OX+9a>wc zHcNBOy)Obm51u_f%QTs*@A%)-^{1bk>6BF5*VB9Tr?2_forpbNy`S%Xxy<&5Gx?Rf z3g?MHyDQgk>|nDzz4l{`?!*pTZuUhP)-Iv`xBBk4?s?!V$o7Hd9p_R0?CGNM7JJsu z{<rg*V{M*J-2S2)ZrL06KR?X5-(4~6nhFc^L=z*!n@9J%R&|EvSh8ta`#q}v<K}%Q zy5P`>jZegzGQJfS#hceHxo@@Ne5On!hh_EMZ<nX)-Kt)(kfCsb=C;R^1461}40nl~ z%)3_bf}v~2*6?Y1bJ~ATuNSCas}n1G?|QDqcHwxJOCf96j#=a^-pf;R^O-a6;R#>! zraX<1d-SCI*zOnoC#IxNjnsF!Hgnmg7@NM|)AyfwZq`#)5x+fqySc@R&zp9HyFadL z&)p(iR(9O9^V>HY=DiyvmCjVG-FAZKr|^|dwLG^?F~Ltmi#C-V>f3gr>7n?XD91ZX ze6zZZkJhg|{A*9g(QeOTwaGk3ZBIOuQZV`!t{nexy2ieb*)feyI%||p3#c56_^a{K zh4bE#&ShGK-_v>;C-S|r?$~Ux_1cc@WvvrgCbk+dwLXt7<e!$oJ^Aar_CLzIb=Biq zB7$6%%?t$Z{NOiY%->~ky)$patQ(%k-&(NcD@_T`E45g_9Thew+wvP1*KMulju)m( zKeoPoWN7j(X?DtoU2RL6GCpoJ3{0JpJ~8-`rqml*d1gQMqCF`UCm(FryFTZmnUOHR z;-;8N#wa#hu84WfXA<UiuCdf}$op6H;9|+PYi#b)&9^pi>sI@UFRW-4b}F1QQQCIB zcnYU#Q>@0t69q~wLH*Z0^RR8q30`S3^`e2-w`)TEjY)O~yYo`kai1@-5ZpVbNJRf{ zNbjW?X@ZWdyt2nu8;Cu5x<E8h;O5~1`%lZ?DEhwCdVIj!YyPth^$CLiqW0|3*%{~e zc}BpcPFa`lPbEEWX)&BTp}2@6>g}=f%6XTjSanUG+BtLPO*<)OPr3Ng2{)`Gjy6rd zvHRHt|Ces@M`V0L1R|Fgmrm#?eQ9#q^YVoDO`6|t6;FM7w_$cpr!VVrG5zI|U-$ZG zoLxBoQtv#M{+*&OhnBzNUZg9gaI0?*_eLdsuC4Jm=Kh(&mcduFeZH9f2eX-`?R8%2 zZ3|LW%8aXZm1gueyM(Qtx~SH}$KqDhTEUHn51Up`nt$oZhs%#x<F+k6(Gz>ph|^qA zX=Bk8hN5TxWFMc8SAKqqX_5KtIgQ_fbF_BcHDdVVd-YbthuMomDl?qbay(~v{$P3g z(P$z^xTgEf_P9e9Kjfc;+D(1IS0i`xMXY}R7tT1F<1ZDaIBmImfOW_Dr=cyIO||pp z-CcPp-&Jj$O^#PghY{CVHKG4yc1HZ}d%MdtVjg)#vp$on_HDdeD8IiXPI>!EW5M(F z5}j-EjAqm{KRF-JzS-xqnwr&$%W;#QDtvB=*&>i*>XmCMulnp<$()9giSMQ*Tb?kg z@L$92cJTx2)WzcA_c(Zc+L)FU?~r8pcED`EV7BkB*^bXu?oW&63w*c0uiDeJI!)(~ z&9T}!>y~F~u?UF&T>bXPQ4g!mlYf~rwlB`V-DltYjUkh(?61)~Hit8k2h?K(9@lN% zA-rF%C$N35#mz$pyBOXHr|p0AN$#Y8{`4CkT*OluJ_Q&onW|7U(YefP5x2bin#-?_ zSTX(JT6)XV{M?bd3>9l9-U{@2bMVKE(^YexsO`3XclG1Pj^?VhONHvib8TfG%gx*; z>t=q$^9|qaP7mIf_a1O@cLmDDR2w|0>=5n!xU}<}phB6|oQhQSf6t}0Rm$Sl_wG2q zb&r{w?YE-NcC&BCYwgxgwz;D&woi2NJE@@i=9>*C_7~avD_0%TaQ(MCdQM1@;Hxji zxyRqT&N=%1@5f0Ga_;al*l%+%p6H$P@jb)4TA#HAW;6EY-FRuX{Ccq5`(#(iPbY7@ z_M3Hd38$dL`F*oqJh}U9*~;R~9j28rfB0@b{~guG8aV6HR+U8WUIz1-H}^a6&(-R4 zu$-54_wY+Qr7(+={$btUw|zfSxow7l(WNDu@_oV=={BTQ&O8&>{a-^V@AqbV&YZ)k zCSG!0z5BT|v#vef@A$6H-q=vhIr@n}krhW!?6WGdk4Klx7K)k95w4oCKJv}%^}CLm z^1Vyc?fxjH9p?Aui^pf1Yt#8y1Sh^(u<+(DGZW9sTWpJDKSk&%&T?(6VVCw?Z@kI= z-5Trt$N#>uX*qJ|b-L!3|BURp|H8Sx&Mw$}^1P18M@vV$Q`MrUbN)*{IyAGxMx^VL z=*7e+1;dSUx#!<X#$M3bKIMg}h~kuA_4fCU2&|WA`23gSaE9ppP?cwOss~s^HVLnv zmwO_3HrKz$3-;y-g&c9_d*^c1VAhv)YWozQXl(H<+tV|1^T%y<8nQ21=gb#1F)_H) z(&SYud06#;l1kgn$5YNZugTGRdD=6kX<J~iu|QU!&h2iE{>vg;-g~q*XWu^<yXs1% z-tB2?Y~DV)r{<(_eR{O_jXaY?AIEh~(=Vt<u9qvG?WFImbgA+4M7vK~7h7apWcKm- z3hY}b`|5zK3C|RnhO~F8OU@q@arsoC)7>4P%6-e`a_?f(hV3F7I!~#Hf8YLCW=_8T zyKOq|hWRr)m{h9XyWb9uNS5fnpc2`fw5P_M?*sdhRqvFl7`D2FHAhVeHjnM9tKQ=J zUF?rELw3OPs>-%`cH0i?-2ZZcPdiF!W9DT4w~?LO7H(Vi?WD>V$3%zKnJfBv94G&Z zTD09HQzWJ{;)~9r?dRDnH%?RR_E=@KSNh39MpM@OldJYSOxt9*B<<FpWlPW9?RcE) zu5?e!<b>FbQ(TYtn@;<@Htn9A=9c4KOeW2C{h!w!Kf6ip?Urh;nbM2y%ewYIS<JKi zT1p?|;yqp4SPJJV-FWT%-F@epUyIi6m2><g=c1!*zF4*<-!<(-$s+4h<yX1Sernao z4;J{@{%t{IYU{;qhjTM?7&_0mFSdKtc4k*=$ANNXzAu)WYSM}>_0^~_-f5fit<YtC zpKODgW3l_Q*p45U+hkIrZnsXUwVwUDdyRf+hS=$l%ZXxVg;_IRfBSku$m-s=dPM`t zx8+8&uat>>X5A}bz1mgnvC{4T&Vskkxj);nFJ)qD`4$J66lJ9eohC7IMPfqf+7m;y z7auu#dP2}%Ucr{T&e0u<(qB)QX*T)kT^%F-qaI7{HywE<fAPY?8X2kNuO~jv+8E@M zozl9>$>?3FNzIJpiF<bN-+ZxN(Rf?<IVEF5skNQA+Dn#kntZv<<Ls?-=)`feuC%7I z48f~<E`NnHUVMGqA@cX@3H#3+nFcpgFXk99Neb~PsNR`(nNj81{w9kPyO-2UcI3b4 zXwt~Okmgc;`9orHK*oQbCyOKdbTT7jpM7vrjJo|vCaUy?aO5Vd+vm6yuOBXPQF#AY zFW=E^G4rOv|Ex1J<Q2`T-*ky={n^o5*Rdl|tX+-k!h-o-OZwlQD3m?@IRBMKcE^jI zGo>USa9b_<vC^PuN38RkhFw7q%2ejbc7ChcFMe{(%@XUg;;{is-q~O1x}x<&!>+w; zmpg;&3V%nx8*4LocK8ZkU1KQ1s`1XD=*9ktx;9~}<|T<dvSU8_K4j5`m!~s#^+s$i zXsc0?y4yczcj6ST7o1zV%&rA>C~7pHmU{e$|H8M<I-L{Q+cX?Dz3e`*DX`b4I$gke z-U?H$qZLeV*F^VUbF%5P+N}9mHC>VWnWo0GESs*T6^@=_`3iN*&e)wu+9e`*{P~H* z8Sj=pKg;xXLh}pRB{$wXoVqJ|WLqbDK-mxZMFn3>S4=inxRy6-xp8G?R<XPPgP<)n zf0CEjUs>?|hP0|tkE&|Rgn3o{g>xl?zbQ!Ws83h3{<BMI=U15&DIJ$nf3pv~*2qx{ zJL6|Q<!`<T*KhgGX{Or^*G2Yxnd_QyG+OLjK!e)S#l1!nogPO|INOQ8O|}&0{c}sA zRHpIX&5b9_FUff_=Pzh*&Gx$7<D@3sCCYljEl<eLe~Zo!+r@jjbKZTls+<vcYGR&= zMC<%~hc$JoTz{eyYt}1#>$a1*AlSJ+H!$Op@rnJRUB^yqZTXhL`RX(45&sqU7z=wZ zYHX^pC{Pz#d){%i-F1_5$v?WEIcb#fIB-4ce4#o;!SHRZ(vi&#KRkCgzc|Wo`s!8k zpLfki_FFyCs1>V_*dcay)@*^o+#|QQiTL)~xNyYwp3m#hs8TdsDSnCZwLrLq+)txz z3VwU09Er~UqUI#AIAF?8$0K{wm2FeSF1gMYou$3-#zp?l=(Lxe9Z!P4OcIkyW!yAN z)rsB3WT{48t|r&cmo10BpOx6Qx1+*LnQ4{Nk>J)d^Q<SVi0GV?X5IN_(bjej!R=0I zANm7U%};sD+&OV=07F*x<IQV7-u-iz@9aJEg(VwQU1mSrF7-C9cSp<DV%<*5ECIn# zOQHR3O6x95w(dCZ++rvlxn@re*VI6Z5RRjLc^buk3}2{D6PA22UE;X-Lf16y3l9o* zrMd{tnz&oy=$yH?Z+S_lJi60;WO~Jo)S7KhoAc)eW(6KOw9(DB^WIgz#q+WrUoN>9 z+ka%P&=FBH=~V4=uBVfZWU?>bXX1MO+KThj7VV2^vG|pwls%bGQf5_)5ck{*3OhwA zn@?YSbx=TRLH5LXNn*uMA65m4i=L6Ze<x;JZ=uccA9dPBVId1{R)}tr(RE_}q@l#Z zs$@4=W6zr%sqX4W9IKTV8F=R}zN>J^xL5Jn^K==tU3VV3Xl$I&?$WW(<%n)@_)EVf z^;#2WBy~l-?tGy=dqPKAS8U!zCc#yqPfod>dSAl-b><0omx!hv^M3v;SJAuMVX<hZ ztH}$=Fsan3Pk(!Txzn!8SMKE5;$*V8Oj&7LshU#R%;xj&78`z@EW7P}n%08t7mP9| zJ70<1H+_+#O-skQOHCc_Rt_m``VK7tDK*=+{@qr+@$6E5dzWhm3r}cll#HAgrr2~| ziEUHMB&i~SjUvL5Yr<rY{@Tm?iP5%ujlIPGneP{{@a7pievw-eKI4Y>7LFavo$*&Y z6xQBft#g070#jz$v}Ha{(*lh6l>=V5b8nh>S+e;*`)`HY;%99?Rx>a#FnGH9xvX<a GXaWG2nJ=CI literal 0 HcmV?d00001 diff --git a/src/docs/codeblock.md b/src/docs/codeblock.md new file mode 100644 index 0000000..2c918e9 --- /dev/null +++ b/src/docs/codeblock.md @@ -0,0 +1,26 @@ +--- +title: "Syntax Highlighting" +metaTitle: "Syntax Highlighting is the meta title tag for this page" +metaDescription: "This is the meta description for this page" +--- + +The following is a code block with JavaScript language syntax highlighting. + +```javascript +import React from 'react'; +``` + +Supports multiple languages. + +The following is a code block with diff. Lines with `+` highlighted in green shade indicating an addition. Lines with `-` highlighted in red shade indicating a deletion. + +```javascript +- const data = ['1','2']; ++ const data = [1,2]; +``` + +## Live Editing example + +```javascript react-live=true +<button className={'btn btn-default'}>Change my text</button> +``` diff --git a/src/docs/codeblock/1-index.md b/src/docs/codeblock/1-index.md new file mode 100644 index 0000000..3b69272 --- /dev/null +++ b/src/docs/codeblock/1-index.md @@ -0,0 +1,26 @@ +--- +title: "Sub Page" +metaTitle: "Syntax Highlighting is the meta title tag for this page" +metaDescription: "This is the meta description for this page" +--- + +The following is a code block with JavaScript language syntax highlighting. + +```cpp +int x = 5; +``` + +Supports multiple languages. + +The following is a code block with diff. Lines with `+` highlighted in green shade indicating an addition. Lines with `-` highlighted in red shade indicating a deletion. + +```javascript +- const data = ['1','2']; ++ const data = [1,2]; +``` + +## Live Editing example + +```javascript react-live=true +<button className={'btn btn-default'}>Change my text</button> +``` diff --git a/src/docs/codeblock/1-index/1-index.md b/src/docs/codeblock/1-index/1-index.md new file mode 100644 index 0000000..73d22ca --- /dev/null +++ b/src/docs/codeblock/1-index/1-index.md @@ -0,0 +1,33 @@ +--- +title: "derp" +metaTitle: "meta derp title" +metaDescription: "This is the meta description" +--- + +DERPDERP +Some introduction text. Lists out all the headings from h1 to h6. Easy to customise. + +# Heading H1 +Heading 1 text + +## Heading H2 +Heading 2 text + +### Heading H3 +Heading 3 text + +#### Heading H4 +Heading 4 text + +##### Heading H5 +Heading 5 text + +###### Heading H6 +Heading 6 text + +## Lists +- Item 1 +- Item 2 +- Item 3 +- Item 4 +- Item 5 diff --git a/src/docs/getting-started/eic_container.md b/src/docs/getting-started/eic_container.md new file mode 100644 index 0000000..c9b3281 --- /dev/null +++ b/src/docs/getting-started/eic_container.md @@ -0,0 +1,18 @@ +--- +title: "EIC Container" +--- + + +## Downloading the container. +```shell +git clone ... +``` + +## Installing the container + +```shell +mkdir build +cmake ../. -DCMAKE_INSTALL_PREFIX=$HOME/stow/eic_container_1.0.0 +make -j4 install +``` + diff --git a/src/docs/getting-started/environment.md b/src/docs/getting-started/environment.md new file mode 100644 index 0000000..68a768d --- /dev/null +++ b/src/docs/getting-started/environment.md @@ -0,0 +1,24 @@ +--- +title: "Development Environment" +--- + +## Development within singularity + +The following helper runs bash inside `eic_container` +```bash +module load eic_container +container_dev +``` + +For projects that you want to build but which are also inside of the container, you must make sure to set `$PATH` and `$LD_LIBRARY_PATH` to point to the development build's installation prefix first. Here we assume your development builds are being installed into `$HOME/stow/development` + +A simple setup script will make sure +```bash +export $PATH=$HOME/stow/development/bin:$PATH +export $LD_LIBRARY_PATH=$HOME/stow/development/lib:$HOME/stow/development/lib64:$LD_LIBRARY_PATH +export $ROOT_INCLUDE_PATH=$HOME/stow/development/include:$ROOT_INCLUDE_PATH +``` + + + + diff --git a/src/docs/getting-started/modulefiles.md b/src/docs/getting-started/modulefiles.md new file mode 100644 index 0000000..ecc8e0e --- /dev/null +++ b/src/docs/getting-started/modulefiles.md @@ -0,0 +1,24 @@ +--- +title: "Modulefiles" +--- + +## What are modulefiles? + +Modulefiles (or Lmod) is installed on almost every HPC system these days. It is a set of tcl/tk or lua scripts to swap software in and out of your current environment. It does this (mostly) by managing your environment variables, namely, `PATH` and `LD_LIBRARY_PATH`. + +```bash +module avail +module list +module load eic_container +module list +module purge +module list +``` + + +https://modules.readthedocs.io/en/latest/ + + + + + diff --git a/src/docs/getting-started/quickstart.md b/src/docs/getting-started/quickstart.md new file mode 100644 index 0000000..2437e91 --- /dev/null +++ b/src/docs/getting-started/quickstart.md @@ -0,0 +1,25 @@ +--- +title: "Quick start" +metaTitle: "Quickstart" +metaDescription: "Getting up and running quickly" +--- + + +# Prerequisites + +The programmer should already be familiar with +- working in the terminal over ssh +- git and gitlab +- using `cmake` +- C++, python, and shell scripting + +[modulefiles](quickstart/1-modulefiles) +[singularity](quickstart/2-singularity) +[eic_container](quickstart/3-eic_container) + +# Clone Tutorial Repository + +# Environment + + + diff --git a/src/docs/getting-started/singularity.md b/src/docs/getting-started/singularity.md new file mode 100644 index 0000000..b06ab61 --- /dev/null +++ b/src/docs/getting-started/singularity.md @@ -0,0 +1,31 @@ +--- +title: "Singularity" +--- + +Singularity is installed on `eic0.phy.anl.gov`, `bebop.lcrc.anl.gov`, and most HPC systems. +Singularity ships the entire container image in a single file. See the extensive singularity documentation to learn more. +```bash +git clone git@eicweb.phy.anl.gov/containers/eic_container.git +cd container +``` + +## Installing the singularity container + +## Using the container + +## Tip + +In your `.bashrc` add +```bash +if [ ! -e /environment ] ; then + running_singularity= +else + running_singularity="\#singularity" +fi +# ... +PS1='${debian_chroot:+($debian_chroot)}\[\033[01;32m\]\u@\h\[\033[00m\]:\[\033[01;34m\]\w\[\033[00m\]${running_singularity}\$ ' +``` +If you are running inside a singularity container your commandline prompt will inform you: + +<pre><font color="#8AE234"><b>whit@wpad</b></font>:<font color="#729FCF"><b>~/stow/eic_container_0.9.13/lib</b></font>\#singularity$</pre> + diff --git a/src/docs/getting-started.mdx b/src/docs/gettingstartedold.mdx similarity index 100% rename from src/docs/getting-started.mdx rename to src/docs/gettingstartedold.mdx diff --git a/src/docs/hackathon.md b/src/docs/hackathon.md new file mode 100644 index 0000000..34744f0 --- /dev/null +++ b/src/docs/hackathon.md @@ -0,0 +1,7 @@ +--- +title: "Simulation Hackathon " +--- + +# Goals + + diff --git a/src/docs/hackathon/1-tasks.md b/src/docs/hackathon/1-tasks.md new file mode 100644 index 0000000..6b3ca06 --- /dev/null +++ b/src/docs/hackathon/1-tasks.md @@ -0,0 +1,7 @@ +--- +title: "Hackathon tasks " +metaTitle: "hackathon" +metaDescription: "EIC software hackathon" +--- + +# Goals diff --git a/src/docs/index.mdx b/src/docs/index.mdx new file mode 100644 index 0000000..48e2c19 --- /dev/null +++ b/src/docs/index.mdx @@ -0,0 +1,45 @@ +--- +title: "EIC Software" +--- + +## Tutorials + +- [Quick start](quickstart.md) - Start here to download software and configure your development environment. + +- [Part 1](part1.md) - An introduction to the detector description starting with a simple detector. +This tutorial shows how to add new parameterized detectors to a library of generic detectors (NPdet). + +- [Part 2](part2.md) - + +This tutorial is broken in to multiple parts. + +* Preface for the new programmer +* Part 0a: Configuring your running environment +* Part 0b: Configuring your development environment +* Part 1: Simple Detector Example +* Part 2: Extending Detector Geometry +* Part 3: Adding a new detector +* Part 4: Detector digitization, volumes, and segmentation +* Part 5: Event reconstruction + + +Some introduction text. Lists out all the headings from h1 to h6. Easy to customise. Some more text. Additional text. + +# Heading H1 +Heading 1 text + +## Heading H2 +Heading 2 text + +### Heading H3 +Heading 3 text + +#### Heading H4 +Heading 4 text + +##### Heading H5 +Heading 5 text + +###### Heading H6 +Heading 6 text + diff --git a/src/docs/introduction.mdx b/src/docs/introduction.mdx new file mode 100644 index 0000000..0a36db1 --- /dev/null +++ b/src/docs/introduction.mdx @@ -0,0 +1,60 @@ +--- +title: "Introduction" +metaTitle: "This is the title tag of this page" +metaDescription: "This is the meta description" +--- + +# Tutorial + +- [Quick start](quickstart.md) +Start here to setup download software and configure your development environment. +- [Part 1](part1.md) +An introduction to detecto description starting with a simple detector. This tutorial shows how to add new parameterized detectors to a library of generic detectors (NPdet). +- [Part 2](part2.md) + +This tutorial is broken in to multiple parts. + +* Preface for the new programmer +* Part 0a: Configuring your running environment +* Part 0b: Configuring your development environment +* Part 1: Simple Detector Example +* Part 2: Extending Detector Geometry +* Part 3: Adding a new detector +* Part 4: Detector digitization, volumes, and segmentation +* Part 5: Event reconstruction + + +Some introduction text. Lists out all the headings from h1 to h6. Easy to customise. Some more text. Additional text. + +# Heading H1 +Heading 1 text + +## Heading H2 +Heading 2 text + +### Heading H3 +Heading 3 text + +#### Heading H4 +Heading 4 text + +##### Heading H5 +Heading 5 text + +###### Heading H6 +Heading 6 text + + + +# Welcome +This tutorial is meant to prepare you to contribute to the simuliation toolkit for the EIC. +The tutorial is not meant to be a representation of the final software workflow, but to put enough pieces +together to do the work required. + + +## Lists +- Item 1 +- Item 2 +- Item 3 +- Item 4 +- Item 5 diff --git a/src/docs/part1.md b/src/docs/part1.md new file mode 100644 index 0000000..65a7b65 --- /dev/null +++ b/src/docs/part1.md @@ -0,0 +1,9 @@ +--- +title: "Part 1: Simple Detector Example" +--- + +The following is a code block with JavaScript language syntax highlighting. + +```javascript +import React from 'react'; +``` diff --git a/src/docs/part1/simple_detector.md b/src/docs/part1/simple_detector.md new file mode 100644 index 0000000..5e8ee65 --- /dev/null +++ b/src/docs/part1/simple_detector.md @@ -0,0 +1,24 @@ +--- +title: "Simple Detector" +--- + +The following is a code block with JavaScript language syntax highlighting. + +```javascript +import React from 'react'; +``` + +Supports multiple languages. + +The following is a code block with diff. Lines with `+` highlighted in green shade indicating an addition. Lines with `-` highlighted in red shade indicating a deletion. + +```javascript +- const data = ['1','2']; ++ const data = [1,2]; +``` + +## Live Editing example + +```javascript react-live=true +<button className={'btn btn-default'}>Change my text</button> +``` diff --git a/src/docs/part2.md b/src/docs/part2.md new file mode 100644 index 0000000..1f3a6d2 --- /dev/null +++ b/src/docs/part2.md @@ -0,0 +1,8 @@ +--- +title: "Extending Detector Geometry" +--- + +The following is a code block with JavaScript language syntax highlighting. + +```javascript +import React from 'react'; -- GitLab