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 zcmV;C9d6=@P)<h;3K|Lk000e1NJLTq007DW003JE1^@s6GG7`_00004b3#c}2nYxW zd<bNS00009a7bBm000ie000ie0hKEb8vp<R8FWQhbW?9;ba!ELWdL_~cP?peYja~^ zaAhuUa%Y?FJQ@H19S%uEK~#90?VWj;6xF%Lf89MR%dm|MtFjFYn=pbJ78Mouh)Ybw z$1UDS5@VE@L@zE;)ToJDqGr`xgHcH|#w{8bAc!I$qAZFa0>dJ!3<CoU%M8=^kGIOM zuIZ(!x~8WG`hA}Bba!>tsZ*!UcfR#}CqNcWh8yNkShA$WbDe+N=iFrH_98sJn9zj& z%NMOlL({UbA=uOnIGj<mhg<gcsyVl2VD;ie=j9RJR7_w5)IX4}wq+5GETJ?JZhedH zg!w7J)~nX#hlAnzc;}W8tN>a97k$=$&}r#vV-^u)38jgU3%>zc0MzHzm+d%f%bZx} z6~U(kgh!aa1L5FrW{w$?lcr{7VIWH=O@PVM7+oLWLhG@r)3%n?x2&tS9t%KyX&@Zb z*RL_K^QP?+($UT=BFGX-n(^)D2@&RZf#|^xL5jCtxo)BLP}czOhr)pY_Bz4=ez~ly ztV1I=H46)}gpy|TZ^!q;FeKK0d&_o@+~0X$1waUPcL|64#;K+~<lWwAjm)9}vV@XG zOnQxWfiQQ)`#%i1Tdu9x0Z>Z#BM6ivsP0G0$_5Yiy^&eOL{=$G9U-8jQQ88nEv23H z_sY4PFz_Ub6IE7MR9k*vWaW&aIUPnPxo^%F`}V&9{2kZ{R2!ex?^VDy<98M*AWJBT z(H`gxbO*Ws3xO@bBgXF%L?9vCb-RIGmQvNVKMWX6FDEx0G~s(N=jEj5l@=6qJ+G+U z*{@Vr)d6jQB1D{a)BqcR&A^w&Gkj_M-T-U_)&K{bwC`|4Ao(eWJh~ua=wp2Lw){2+ zT`d}14*|~scc4MG84a?nz$P?v?*PK~n@oP2H^Xp7vc|N^@AUD{Puz6O{EILBylBa% z{T#G^bxvK)fYOyK_gjvcMAHW70CYn{-3{mjbTvM^VVJ0agTPu~CGdsqvx38%hz=)0 zDFg-qLxH1_LVYwEOrQb25?Ey^=I;$I?o$91qXD=AIDXvEIjj71?nriF_#pM;j(RIR ztpDku>MdLN^u)2W4<=V5m+#;E*aa0|JO=DB%1#&UZH+i)DViM2QfeFzA|hG?ECv<< zuNj{WCWJ#3hpOn+0yqx%1`)#Oi$tU<^pZaY{t7Hb#88=_z7U#)j{<rS(MdWYqA0ff zZe?6k3*_bG@^Ftqe8Wkj>(&ns4m<O70E$XVs62Bl?ce@y((8`Q&A+Z=PVRME>uSwI zVZ`OWBEtFR1HT6@GmdXS9Aqc(nNjS>2YR8t>xcUC5@0*(<CjriE;K$rL|o{Q!=b`a zIsqer(ZDF69LPlk@G+VRml&Vx;?&U|7=UKe9*8J@0sIuW4oxcijqA4{C3&k+wi)Fs z%YS=-9h0XqDIDg$WDl^nI>^sXUPH(B-M>CoUsuPQLx<DrVDgE3UpPFq{PRz4Mxick z5Yd(xebW(G4?GUc1v(Sqq}zejNW7}Bd|!<Ssg~I242(m4Jro#>h-Wh}8+gwsOAtqD z)@ZJTQjFyN(-2|wK`-=UU=Dgw@1sF$he;3vZJ(Wy9BvMfwZMHutX6A~9^zQsxMeye zx%I3-`a(jqtGtql<EJz@{^8Tl(CXd?oV=)TeUK3YKU?yF!{!wrZqYN&XDigF%YjdU zzo7nYi~7Qj5aQe?7-cjf(rO~_<iCisH9Nv-E`$;UhNFQx8h8fS2fT|2;yuLnYhqm6 z9k?8cV#ARLbpZGrScV3H`MDCP^Q+O5-)2e}u1t2`&JBe;czHFUP;5!~g^?#RsLGMr zF|Ta-l92&_bcZ95xHSk7z^jNuO+n(?QpBM@0Oq0ow4)TguM>^WK1jrU6L=kX3vslJ zM<x?WE8v^JIf#240o(vQk6zp?V6Wx;AX3mrAfh-9_z&<mB%9AS%3^#bh*<c=TMP>Z zn2!Ue?lHNKGH%RuasOYxa1q<aUrwO|#XcMeTrptT;-_6T)*ZSbF>5dqxkeySwGt7` zJS5)DN2YNrdID#o_c{iN$8!<UybgTQi0w`ZnMNr2z*)d};9NAwW&&>*Wu@)>-oUBA zSm0zNR((c<C}twdQ+g35aK|*>MYCu^>{@*k5B*?G(kfs0&Ls@`B$mG20Go5_3j39= z{2-l9#?HuaGQ#*A4&<Rp>20IT0<233TA+7#wo#5mV%}7vtV&bc9U&74B?O#;tSJ{D zPBH`d2k;Wnrp~sAyNoqT4@3wvj53qVVC4ZO4Vw!bpYW`Mp?VJ97Nm8j<TdW!OW`v! z2?X0DJ9A4xUa0T(mDe|=H$E3}o0EXkfim>29zm1cTZkyEC`V&pJQA1ZB7%7y8BCfK zO-U$Sfgb`_BiZ+TL>&L5VaHqmd>;|i4q&=bW)R<s)wGy&%rFQf7QHIZ+D4ag2}4?} z2+f_dCx3akWukKegulCI-A|u#-q5rlgt*E5Xrdd8j3qCk_dSn@UKK>ffJ=dkkRfFn zve^BbCNcyx1)+=qt_99Vro=xZJ;FNRy8{;@0=W_C8@&;Sd7o$&o(ftZN2Jy1xR+?% z$2%qsdkVNB_MaU#l6z+{!BC!?DhsF1UliD1J2cMUAJweec^pjktA9+iL{>7hpQ@3m z+^&N-MHeJ)U4+E1O~4B@B$|BSOk@xlhsMYsfQRvK3^+o%2&E+&FxMh;>`bI!zd}T* z&PRmtJ;XUypc&_JH2b8AGNdz%K$e^y$iEN^+lg4hrlT3njkjC4<@gfn>tdUS^X{HY zpm;>XixMMPxo2g;tBZQj&{-S~6FhP6x{0%0w=)_8k;#1oGMo2AhLl*?i$tlF$aFj% zSb#f2Ne47(ej5?ZMieIW7ozpcBY__wZgdWC8*+Gl>f&CW(b$C20zKS~Xy$$z5r|bQ zJsJ_mWybGkf&W8_V5;Z?{14(zPU5EGp%(ZTTE08q)s>Tm-3;6tbu2h=2{}I=Ou$?J z7regY-Qd<;C)y7Gt!CW~Nlnpl&=<H0&G3CZ)?uOw4f4m3lhX}4pvm$|M65HB#PK50 z#Md7AWQHJ9^X<qz&}e9^^(ZZnM|(A*{6C=?;aWr_IY<VbkHQ}Y0zXE2%k`vABqty% z+2_E`q(&ql<#asq89YOLPSg+u`yL`HtRq-Y-h^DQL;|pX?0~@pqKp>13FqAGp{f&6 zKP>|$kvfrp0!eQ~R;ypoFtR!kDiM*LfH=pez&&WZOn|SWueT#(!O2Jx`2ca3qf>8w zZ1_zm`M^(5C*1)&fmrt)Nd9ku2;vJg<4i|Rsj+BX#l95pUxw`Q?;_bY+4F5M&V2>x zK2EGFm!i0)VUAifdFcTH-1PPD(0Q{7=l6GXZ5)L2bK2GR@AS3LAprN*tiNufiz@md z2jVQ8^^+Im0(YSqzeSRBV__*U5plaP@LeQ|O+}(Jz&l7xAB!fhg~%XO=Dpdm;iu?z z3R1MXAR>5(XjAQ(NNGQSM3~3%t_<3dgJ!YYk<yt6HO9UFOhXf82+gwhk<7HKH7BPb z<uf^M9`+`*Jf8gf4-yWhzTUk)Tvzz)yox|weW)h5b0BLbJDFsH$Z2~w5`~kY8V$^8 zXmZ<uCc`#JLKuYly>*g$o<Y$Osp5Dfp`48-w_hUN$iz8_IESFIcpE+~TJwWYIsp%& znf5s(a+$MR0eUexh)7OFo#yA-hGOHsr#LwGL!+I^B3y%rn7)_fyv@L|Xc1Im+%kL+ zp&K40SbDO9b~-{%#kPgHvp)aj-nBQp=-~8rXtq7w!MXKlGP|3^MvOlJKX6bVsGk-% zJU1DJ0=FXF)6`KuGX4ty7bDBqK@`xMd=*?HB8YU3D#Q}4FCYMX2SuT-Grl(l`lA57 zu!Hgj?nHnfV(rQ5eKqB$XngcW@5o6%?MB=`8UDv%eP(&cx2K6<0OELcNJ6msq}l?1 zM8xtE3cYC(T!hSncMvV^3`dcoyOA>IMLu<ca->r@c}X856SZ3mK(lMI`jf6)Y(n%y z9M4HV?MHsDWN3xBsT)Fh+o$J=g;D4oS0XE`)qpS(83n3IE+P1e^MNN3*XUt6o`+=n zS`=a0wGrD;hC0Q`3pzkV`SXG|9Nc3@3iUT8jzVIv)4}{>hxK0SqE55C=f?vjKnO*8 zR3fF`YHY~`CL_)>6$i^6Qb7>Oto0~n$LjDJfGB!B&UA%TP=d_PPG8WkQoP^y9o(ZH zDYt&02t8vj#5G6ZjVl+SXk4fLG!y4K>r*c3HOoIeJcAc>Kz_JAG&JL%gt+T6WNq~w zg-9W)L9>a808*A}ka;&&1`t0HL?&gYFJ}X(i+=qa-s}1#_1uXJ8vjIAr1#Oxw+byV ztBzCeLA;5LFF0(sc@H-}h-ohBHp@>uJVPqzhoYMQMzrqI5plOlWL)wM?U2r~8R;J; zTA-I+MKtj=CMMzT<=p1OJ%eZ>NOrI164ViLSVyelCEVPtqWyx)`rQ)B0VD>d8%Lrj z<PFG)X(A8hOW2Qe?Ud0LiBzkI_S$wvroKjFVKGpO9Fk67&OY3D&=X^wgZm{iIhVO; zx4rz^Wm`KFpF71XV_n|kA(!<(?y`PAkqbP4#>05a@c@cut|M;Xsx!1g)VPX<ius>W ztWDcgZr~D5lxl04>f^l^JGkEg;)iQo<g)G7;#S9+;<El#xcAHtKm*K4{Y!~trfEw2 z0KFr-!Qu{NfV#j-r6H8N=}Q!XVxk-HGbDB;^MLz_Q*l4Qd|{~u-gS7-cpU6#^n(5u zIm(_y=5r@?x|!{U;>?_FEw{R;--;U?+-na0adkg%0TQ>awH<#Lah#EED|`T14UVxK zYme;FZ{jY{%@4eTyO+O@<Y5(VFvsD29V}J+8dp24(^*WJ@Vvu1ttFL2-{+$sS9_hG zA!}i}$B7es3vrf<Eyn_=?>6GXt#KxrDXiY~5K`dg<IMt-3XaG9%YVz~HY{{_-!3ld z{EmbA+*rIyjq}~~(+2zrW9mmF3CK}C)YsU!206>E@q8_jh&>AjqG&rrRZrTE--W#3 zO%Vq01nvpN4{MhdUpTz4oBp}hL49s4UcYkKMr*OZ=ferVM<G_$Bm@JIG%_*S#lJ;* ziB)Vl1}QsE;(z=`OWa#<!pO1Y7lLT^adKZbex%<zsLyE}SqM3M-S*R!F4}vjp#X7^ zDYoO2P*i(dF}f7VZq{(<0E)P^SC%fEhx?a*5Pz*KT^-)nZ8*0RUqsSWtOmw7Y@@vl zblK)Z4a1Q2Zj|L%9^&M8#=Gc`$dqT5SuaG^nWnN_JdXR9zs%=0jCOcmw`;dIIH>co zxK~Hxeur(e6LxmTHHr52JOjP386wPht+vPv`4iNMCT>QuTvO#$a<X>9j<(2x;TN1* zLENNGYKt?)f2qUzyokk%NpmKX48=Xj;Tj+^_E#fc;g=}B@oQXxLM*Hz%Mc{SSp6vJ zL<!!+iKZ%X_hyWNkq+uRh_g7g*0{HJg^>i2g)jnz=UZ_PmS_u;^`3|PBfBjpUW8au zMI$ya5#0C>G68S8IM<18u$tIO$L%-<Zz7aaZgn`I3tCp3YdQ7`3fn4!i0Cx}__gig zF*NRCn`H31hNOaM@v$*cWt3-;Q_?9K>>VEiP6u+lWO&Kow=UP5@isCO4<WK#c>!7m zJqlQ!gUn!^iL5y;KyLnW;L&up)&@r#gW9kQEqhHDp?HN8LUELl8$GWVWC<mLT`1AW za3X|KkJj@H2C-~YsWg?*FiQ5;5|4pmKEaD_WUdR(bT|>coN^Q|{Zx(8m}U_{1q~g> zt1uSi<)9T|5ZS|UKk}#SAx-Hj<G@QwpXRWCU=jXWyu2*AUQY9vP|}GVMEB(xNZKj@ z&d4F62wLsN&m(Tqlsbx+m5G^|**+QrNgiKykk~s|#e$dEyXMeO=|*3~986RYS*LS# zkcf5ZG|NfTkcYA<_u6xn<=udrY>7<;rxq`#8TGwPD9xdt(v6-(kGT~@!l&*FqAeC6 z+K#*nu_7-DwO`ns{FDZ04sy4j7BBENnKg%gN+*V(Wh8bpdo3cEkAp;3tCgaCNK81| zTCEYW!^1UulAqG#@YCW2Ubdsij9tkx2{$1kv2v6Ea_0UW<Ii6s=gI=2H=CS+_ET&s zxZN@U{7u!`Sn!*pRC#DaCTvNVN%#cq@iLJJS1Cu?hhD-s_#fm|K9%SWd>+~8T`!OH z30^$M=^&IswB5i3xX<NPgtIj(Zl2w#(r-m3t~_i?T!=CX%_b86c0Mu>N4<-7C|u%7 zTLtDGdrg7UaUZ{QUL&`uGZD{!7>TTIGMIdW<j+utvrO|QCOW9oUXtY?^MYKo5NtI{ zZ8aYy=FW7SfOL`WmSZ`{GI&p{3r5lK1(l;0SKbH>OojrabGR7*_P{p35o=Aln?dI! z-<DerQSP8ldr38WW-R<X#(kWwr)eq#5EuEY?fAt=I*G~s18BFSZ`+PPgZ2Pv3U>W6 z?gl{28Ner85aWKexD&q~j8TWZIN8F%iU95tX20U{9?1|dm)P(`7i9qQP%xyGAaapI zc1ofPA4jay>clz%_zI=kNjJ{K-2iy4k=jvA?7{e$%X*yTCc8WC)$#F&gL<u{5`PzM zJssm7nZ6xHH^fQo4%>-H4e8$C3JZ!+9$b4c<avk{jq#<4&JiGXI-GcAC;sOfD<pPa zuZ_6RwY)Y)J@#^mhc@=deLk;~JlrQ1z7?bH8dBdkvoVp6az9Tadcr70{<~Y8RB{pO z^mA>;??s%&_x<sb;B4Ft06(@sGm%Sd@$UfceN3%zHkiF`*y%Q>*Ha$vV?`PA$=K^o zn#H6E5kSwrn&{-+=BBB0X}C3cT>K8%=lfcY1yP#PwIpFnjQ}^9*}p&!ohpt%Ii6zO z!|6UERyfH|R*Uzx_r!U&m@qQZq_S^JSE4O|W_g*+UW@-IB5wP$KM8EZWi(12N{zn? zDQec^zd`PPKQl2VLtEq!aykf7UFLcg@x`Q@5?q%ES0!k#S?rsyy2UjP?qMy9@fIsq zPVDqZ^E}p<4g?XA?4Y69`ZhF4dD;e|9r9Q%A(};jd<PpzuQReg?yNh%$NlU)gv8wI zXDPJ*0S9gVR|@r;aJ$LREHv>sK|acR70Yb@8REj3h&&XE@)glxS|Bm89&OL<8C}pU zx0L8L6d{!Qe?Q*D5U&`3^Zf|JXcga8B<6l4zyuVs6R)0a$WxmN{^Ov%ZW2_)Lk{jl z)i9d$t|q=A<S4XFcD#(4v+=fmC>`j9oSzjmG%(zRf=YcE!zI8XB!=1Jl+Ht}Y%1x? zNnC=qQFAj8YEdlPiztuN6twS1g@bF~!Ck7<c`n<QtUT@F-X=mQ*OyyM*lsjoOhK-K zm(U~`uO4%oLN7}q(t-1lKJqHjgd9X1z79<gzM&oJz#TLUlpKI&?j@wp!4yRDcr1&H zUu6s0JkyP%HGsDiu!+hf7x%a09Gq`2?zSvPF>jfO0wj9xN83|aV;GCjBw2%EynIIv z@CU@I?jm{swMJHhT9i{aU5b8tv_<z8{2KskQ0IDihMqpQ!z|zQ&<-nFBC%<cPwiQW zwxPDB_Q@plL193vX{e73L6iDgqPH|@6kLf|^em#c&jvZMmLZEssxrMB<e>pI1#ii! zzd)9<F{EbN{HCSO-H79DM<U)TG{_d%$_nGZHJ0<OX5Jntw8x49G=n~m^R36tvL5ZU zdkUEwqTd}wkL05ar`BYS0i(Q%wghpVBG~Ig_eZ&``l7A99zpURL@XmWqaA#2MP|r! zqC3iW)eFt?g(z=R5c!Appjl;w(YC{FX>0(A%txa>>W0j^g^0j+BM$UAvV3N8(vEy2 z0o;a^_Hjh7jvas|L32muU5NP8h8$#C+l7>UJDcl^tS@zF7RyxAVHV931!(K`^~e%B z-u8bXFd6N4GMm(P7V`zY5Id_yCgUR8|3eYm&PV3BzGRVwceFqpWFsPwi8NduauyP2 zE0I+zqr}C_kW#%35ro}CTZp1(>yVi?ljYqkG7rT_q~C(X<{#0}p?n+~WA(`Knz2$$ zYh;D0LNe}kG<=w2k-WGM+32q!GqzXGA~P`>t%=%)bfyV3^xF(WODw|3$2N*)f_7*T z)h<N+6KLr5?T8fp^~gW-2x&0cWzlRf0vQqxASK+M(*Y#bzk)c(yQF^^h;QhKf+%ay zW<+<>@L_XMX#Wi4qgjqDX<1$7@IoP4+wvS*b=VVGvO3$&3nACTbVMNU<1TMOMxz6= zasLIGXdfXqd+dr7wfTsReu%hH7KbJZ(4e1+q>t^$aUIL!Z|W#(i0HYQ8X4dVI->Zg zFmkwEL+pUMQs8zZo*jwydcPORtl4xs%@<uzr0ze^iqtCPC_aaVx<>#-s82yo*sW*` zxJ?t)tT7Y?DDFUV=)aLIJXWfnVie*&1I6!DqOj@9X}XPAvv7udBpTh1oV#I^3g`*6 ziZ<3#h#@G0%NpbS5773Bek{mqwkSZd>5Is+QH@M{XAnD{s5J`3cmnOLTaVU4JdQfE zDf1;~Aq(ayDCTNBih`&?NfvJ)ex}Sm$YQz_5y$7qVVLfv=gk7`kb~$Qq}cC3%H0*j zwuuK&cK9EnaP&2(lQ$sNZknevd1-2MM^E5Vw0!(yq(9W4_t+aHGK?i9gpi(kk8zzD zQ}!SkxPNCRJN&vLx%C`m8Z1Q0{cFJMC~PKH%uY9y{cki1`yYvxHMcRYS&a0ZMQFua z7S2$BCZ(f|G8l<S#mGZG7wuy?7Y+Q{7<C+h-r2FpH_{$S18<;!MQcjaj6x<8iWLRO zMs5;LPqZxfJ)^vfZ0_+od6-ekk!~~?g`aOgtbQd5{99psuORk|J{-^yiLY%@Xwoyt zzg3FH%PO??XbI}`1;kIN-T`rq(I~QfIB+Ktt<OQLKG!tPWB7~aLMV0&KnmiC=p~dO zG3|XK#Iu0-NxOsS#Sb;=>SO%wgT%i&<S2a>co?`A&6=AKac#ugwiHc`JVXdxjn8g~ zD0(3=sTa}#>kwBs9{Do1AWpoL#9M3hCPEmaP?Y&W#Jy)DJ!KZsMVl3xE1}rY4~bi5 z>4}KsQ}mJ+8f5{pnk7O9L^P!+Zfz+Fx#@($_stl#y@+@=BLb>I#8ZXLo;#4JSc#lw zJBjR~wTB21w?by{k5H<gWbFfqk*!bwYHQ=Ot?}Lb-44y(H=%T}B}ALyw;JtUjktvM zb1jKEY7h}sITF8yBCgXJg}Bc{gfSagth{Url~FiU2*r+WD0BQV=p~jD8R(Z7#}}bR zW-HL(aJpqg5t@;^7{#2O+uBMSWa8Y5#Fu#3Wqh_mvu~YIYEi_(u|_?K-qlW{o@(RM zblzQ$#GMkv6*e1XE6zpBV#H|&qrNmn*Vd@dmZH8~ggE+QB5RWl862vF5(}NsAh{HI zgUiwC!4MjtYmuH}7IWp{dQuk^%o*R@T(*sIJjeKcD>7D8pxJm8vK%c!1M(;$1O*~K zlPJ9GxMfEt#6f!_qA*Kuqun6FGmRnU=Vu%yy4>MJD6x=-M2Nmb#4S@-=}x47Dv_9C zidyT5=qsC$h-QjiZqWh}s#WC5Mau7V5A~VIM?_eHxSsj>cO)*|h&ZCTMKtIcRvKlM z<@-wX+=nd=cS1>oLNudxBO<nSCL(s3gU{}xG4+!jw(n*tptsO6X_G_LS-zK|K|F+r z&eDR2M>;@chA%*bP-J|zwf(kxvCX9qKSb8SamXmK8CjlIA%f2$2C{^b8gdY^6cZV& zRvpFqy$$jKJ&UYA82_2?paczWGePtoq*s{OOSA~M1BqYNh#;-st1REQAOdN2mZnTX nmQXSeBT(o^3$l^Z8H4`^`yksF%{}pZ00000NkvXXu0mjfmzgh~ 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