Skip to content

Commit

Permalink
Update README with installation instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
morriscb committed Dec 11, 2024
1 parent c02e99e commit fd1db6d
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 3 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,23 @@ We are not currently supporting this code, but simply releasing it to the
community AS IS but are not able to provide any guarantees of support. The
community is welcome to submit issues, but you should not expect an active
response.

## Installation

To install base package with the cache object in your python environment, use
pip with the following command:

```console
pip install git+https://github.com/alleninstitute/abc_atlas_access.git
```

To install the package with all optional dependencies, specifically those needed
to re-run the notebooks, you can use the following command:

```console
pip install "abc_atlas_access[notebooks] @ git+https://github.com/alleninstitute/abc_atlas_access.git"
```

We assume that you already have Jupyter installed if you are re-running the
notebooks. Running the [getting_started notebook](https://alleninstitute.github.io/abc_atlas_access/notebooks/getting_started.html)
will also help you install the package.
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ classifiers = [

[project.optional-dependencies]
notebooks = [
"matplotlib",
"scipy",
"SimpleITK"
"matplotlib",
"scipy",
"SimpleITK"
]
jupyter-book = [
"ghp-import",
Expand Down

0 comments on commit fd1db6d

Please sign in to comment.