From 29c85ef2b625c784cf7e3541919f13d01d129b34 Mon Sep 17 00:00:00 2001
From: rdamaral <rna5137@psu.edu>
Date: Thu, 2 May 2024 13:46:15 -0400
Subject: [PATCH] update notebooks README

---
 .devcontainer.json                          |   2 +-
 .gitignore                                  |   2 +-
 contributions/contrib_1_02May24_1449.tar.gz | Bin 2127 -> 0 bytes
 notebooks/README.md                         |   9 +++++++++
 4 files changed, 11 insertions(+), 2 deletions(-)
 delete mode 100644 contributions/contrib_1_02May24_1449.tar.gz
 create mode 100644 notebooks/README.md

diff --git a/.devcontainer.json b/.devcontainer.json
index 8d6dd19..166ff3d 100644
--- a/.devcontainer.json
+++ b/.devcontainer.json
@@ -3,7 +3,7 @@
     "customizations": {
       "codespaces": {
         "openFiles": [
-          "notebooks/TdH2.ipynb"
+          "notebooks/README.md"
         ]
       },
       "vscode": {
diff --git a/.gitignore b/.gitignore
index dfe362b..ae787de 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,5 +1,5 @@
 /local/
-/mhdb/aux/
+/mhdb/dev/
 *.pyc
 **/__pycache__
 runner*
\ No newline at end of file
diff --git a/contributions/contrib_1_02May24_1449.tar.gz b/contributions/contrib_1_02May24_1449.tar.gz
deleted file mode 100644
index 1298420ed0a1a855e706da7c8851987c7ca2a49b..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001

literal 2127
zcmV-V2(b4biwFShr!!^(1Kd~1juSx)<&4BXG!jTa5mUCyE*nm4!ypY|N8&UJ5Q&I=
z`+r<%vUC#2fDi|2mQGi--+Q)S_0)WQ_2SEwqseGI8yy}$pFrH7`r9MN&{EnJtKj?|
zYmI9gsH}Vni&Wwg-}zKV)-0#GeCi*JZ(qJnK6l-z&)?p^pML)NbFV(Ud=u;c+c-D+
z7vs$7bCh#AbNXM=wXfT6r|+ikzjjwf-Nv|mbo=I$NB76acP3w!lX>T-vn!mV$tKRN
z!<!G<71_YE&gWEB+Ep~BXgz*B+l)WBdGq)>1`T8}b?#?Nwc4)aP+iv%4!g~PSLpcO
z{iEB*hjby5x!6xa#(tTwx?2;NL9Lwq5w${mc6|ddW^O)xdT(!4qP~wmPG8QZQNTlL
zKl8bRr{kMX?%p4FcaD!H$9;Xs4N$sKbu}mnDFc~YdNLvfE|;EMdi(yulZ&GaIU~7X
zjj2m?trN-J^E0OxtRrSaD44_{D`Eg(1yu0?gmJ}+bBLs1&NLn6Jjdh_yO(0^^Mw&!
zyw*|9Lk<+p2A(je*n@%#a5nov5h108jJqA#9^HNT^zN-?zQRnP5>P;#=W<(P%+}>n
z4zb#+C2+1)nq2MWBC`}+$wlNcEQuFNSm(IECpN6N>WpG`uw)KatpO22bsQG9<g)0^
zNPxstR+ZhM4XKEGa*>AG(q{)Qbpe_Jv`}U$Jtjj|rB(KcAiEcurXcxM%P44?ud0ER
z@_S{tv0estAwW%LkSmoxtAh>YF`-%*PgEd>q$J2t3a&x2RdVS)P{5^F!;>G51r@_#
z5q1?@xmNH*Xi%J65gdfqi-71njA2#G36Xfd4;u&+<n;y#yPEXLmble2Xb_^-y$v$T
z0`AeE0>=6q4I0k|4N5E=NF<@T0Quah%_U9G(RkS)D|zt_!Adqv+K~jLVxrov9vFoI
z7YGRfW2H<JW1o|UKK_}$;XV?q-VB6T!KAF@wM0)Ok7}%fiX>`KEK7NTFp!r|q;K=3
zlu!#6P}7kEdu`1CBgW=Anj_Y<NNk5bm*P-sA~g`Vp}JoRxpV#TQbm^varR*5+V)s6
zm5L3G3UJAJ)sA_^)Us-k#d{(iu!34wRtyIXOxH7LHej?SQQ4KL5o91$lYwJ2vnfj7
zm4ra%8A;ahZ3`bAO`&>CD1jezf{nm|N-a9bfG}1w{m1|TOK}yfs~1P$QB?t#wVk9p
zNVzBwmgJDDI}vFkH6S;s15(shIP5tqRHI@)s%AZBHOW?1gp#)jOQ`}%HL*gij8>_c
z1|guU46`iAEV|4x3yRR-?Wnu`aY#ddgwKe;D|r(MLY1v@&&yJC9r9K&cj|eQs2Bk+
zvWm=$vS-!0E(EtyMazKMtc+Sek&Kl3GlmtDIxvhh|5?w+fJM;;_@fBVnRTs~xWPBV
zpbAD+OisW^nTod*39@9P0U_o}Ml1`5Vj;t7yw*$>4Gw~(frh*B!RyJFX%}b2t9QEd
z9d;PAH$S}p@^$w0Tbu;jN_Vw8r1%vp4<?@{@1|d;pSwHlTzNSbu66n1qCv}+B?HFN
zOLZ`HVv0KGr3XQ;Tl7b>Pv2&*cJlX2!G1Kk97p9~+*Z;*b2%Ovidmh$mZZBQ19&5H
zJUe0J;XKfD4y#yZNzHGG){H2Z7FF4cwUt6b5Y9!Nrzw|_fpZnnxQqRJLO5K(DTsTs
z=^U*>Et#q0xZ4lc7k{8G^r&ZN^%4*qVskCz1^uLm%Y;{$h=r;FQAsssoKB8|>p04S
z2<D2ZWKe8>Zg+VvP7+}}3hVKP_1enSu-$le_3-ku>sz*q^~QVk+4XJP#oCH&J1ite
z*p}z^h6US33lLPv`jSgRD4CFv;*P?H%YU~L?(^Y_;_|k*gt?7f^}F@@<;Q;Kb{q9;
zE6a_$y=&X@cK?@(S6tn8TtghhEl*uZ20C|BUfzt}Ot0%!2_7sBg2M#c%6fjW-=1CH
z&hy|GHaYltzYl(Hlf7ZvHW4uNTv^)APYg9@iV=4>u*peYR|orSvRB*XjX3^Jd)Xt$
z4Z~pcDqEzoA`E^AfXE3{<qj!a<OVr@v{06-EJZ2Kj4NwK^x)xrAgP6@u9a-%kqaTO
zoe4353zxj96}Q{jfK{=b!Um{ZJ>KWCU6l`wUBlhg^h4HgxBTUG!nc>-R;rwXKKopd
z)UR_cZ%ulGnav9!_>AE9?R(7Q-+xL1$;~^Ue0xfiD-Mx-ha_(eio%5uN}UK$%LuDk
zq8{o>(!kMyA+@3im1RO;(-90m9dVDtmyUSkhzE{JRg8%UIQ%3yvQ3f=q9eP^j_fi#
zvL~6<(7?$9LWjDVt)uWRWsO`No1zFUz@jTAnEFYCo=`rB&@UtO%Lx4m##V~cBo3w8
z2ufG~kyPs+?XmLxIae+@1k-(lv5PPQJ-`aqiBJJm#zE?Gw<b3PbPK*eNG(RXKIr|a
zm%05{0zc4~Bl2992Y8;sd-hgt*TSQ4Yb3X9uuwa2X9m$Kf9@nP(xXquFQ1MffT|k?
z1J)j+w@mY|^h`JHH%(j8q@H{qw8hy|UaF&gq`Q4&wI~6H)QJOFcQbogVL2_(UyL)O
zs4K{Q04r$q@{wv^UptzMJL60Wt~MOzWiyPxIlTGMn_ima^n2!c*^rjk{%3^{G{MLb
zC=jy6Kiy0IJxktyE{qDTLB3Y1P~Bau=I^C|2qdKPJ|9;j?yH@&)oX@|MTzaP!_bTK
zusQxvZ&~htoBJns{oD{>`8^X*D+y!;;SeFo2!>HG3P!;w7zLwX6pVtA3;>_-n=k+<
F0090$4EF#4

diff --git a/notebooks/README.md b/notebooks/README.md
new file mode 100644
index 0000000..18e9b61
--- /dev/null
+++ b/notebooks/README.md
@@ -0,0 +1,9 @@
+# MHDB Notebooks
+
+## Quick Start
+
+Thank you for your interest in MHDB. 
+
+This is a Quick Start guide to get you up and running with MHDB's dataset and calculations. If you are running this notebook through pre-configured Codespaces, you are ready to go as several steps have already been completed for you. If you picked it up from GitHub on your own, make sure you have Python installed on your local machine, clone the repository, navigate to the project directory, and install the necessary dependencies using pip by running `pip install -r requirements.txt` in your terminal.
+
+To start, open the [**`TdH2.ipynb`**](TdH2.ipynb) notebook inside this directory and follow the instructions there. **Please note, once prompted to select a kernel (after running the first code cell), you should select the `base` kernel (which should show up as recommended).**
\ No newline at end of file