Skip to content

Commit

Permalink
update notebooks README
Browse files Browse the repository at this point in the history
  • Loading branch information
ricardonpa committed May 2, 2024
1 parent 5fe04e3 commit 29c85ef
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"customizations": {
"codespaces": {
"openFiles": [
"notebooks/TdH2.ipynb"
"notebooks/README.md"
]
},
"vscode": {
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/local/
/mhdb/aux/
/mhdb/dev/
*.pyc
**/__pycache__
runner*
Binary file removed contributions/contrib_1_02May24_1449.tar.gz
Binary file not shown.
9 changes: 9 additions & 0 deletions notebooks/README.md
Original file line number Diff line number Diff line change
@@ -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).**

0 comments on commit 29c85ef

Please sign in to comment.