Skip to content

Commit

Permalink
Update installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
mengqi-z committed Jun 28, 2024
1 parent 77edff9 commit d014f48
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions notebooks/quickstarter.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -19,21 +19,27 @@
"\n",
"**Option 1:**\n",
"\n",
"Install ``GLORY`` from a command prompt or terminal:\n",
"\n",
"`pip install glory`\n",
"\n",
"**Option 2:**\n",
"\n",
"You can install `GLORY` from Github using `pip` in a command prompt or terminal:\n",
"\n",
"`pip install git+https://github.com/JGCRI/glory`\n",
"\n",
"This command will automatically install the dependencies. To avoid package version conflicts, consider using a virtual environment.\n",
"\n",
"**Option 2:**\n",
"**Option 3:**\n",
"\n",
"Alternatively, users can clone the `GLORY` package from GitHub. Navigate to the desired directory:\n",
"\n",
"`git clone https://github.com/JGCRI/glory`\n",
"\n",
"Then, navigate into the cloned glory folder and install GLORY from a command prompt or terminal:\n",
"\n",
"`pip install`\n",
"`pip install .`\n",
"\n",
"Try importing `GLORY` to confirm that installation was successful:"
],
Expand Down Expand Up @@ -79,7 +85,7 @@
"glory.get_example_data()\n",
"\n",
"# check the path to the default downloaded folder\n",
"example_dir = glory.default_download_dir"
"example_dir = glory.DEFAULT_DOWNLOAD_DIR"
],
"metadata": {
"collapsed": false
Expand Down Expand Up @@ -132,7 +138,7 @@
"import glory\n",
"\n",
"# modify the corresponding directories (e.g., root and gcam exe) in the yaml file\n",
"config_file = os.path.join(glory.default_download_dir, 'example_config.yml')\n",
"config_file = os.path.join(glory.DEFAULT_DOWNLOAD_DIR, 'example_config.yml')\n",
"\n",
"# run glory model\n",
"glory.run_model(config_file=config_file)"
Expand Down

0 comments on commit d014f48

Please sign in to comment.