-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #494 from scipp/update-install-instructions
Update installation instructions
- Loading branch information
Showing
3 changed files
with
43 additions
and
111 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Installation | ||
|
||
ScippNeutron is available on Pip and Conda. | ||
If you need Mantid, you need to use Conda because Mantid is not available on Pip. | ||
|
||
`````{tab-set} | ||
````{tab-item} pip | ||
```sh | ||
pip install scippneutron | ||
``` | ||
This will install both ScippNeutron and its dependencies which include Scipp and ScippNexus. | ||
By default, this will only install minimal requirements. | ||
If you wish to use plotting features, you can install all the optional dependencies by doing | ||
```sh | ||
pip install scippneutron[all] | ||
``` | ||
See the [scipp documentation](https://scipp.github.io/getting-started/installation.html) | ||
for more about extra dependencies. | ||
```` | ||
````{tab-item} conda | ||
```sh | ||
conda install -c conda-forge -c scipp scippneutron | ||
``` | ||
This will install ScippNeutron and all its dependencies. | ||
However, if you need Mantid, you need to install that separately, e.g., using | ||
```sh | ||
conda install -c conda-forge -c scipp -c mantid mantid scippneutron | ||
``` | ||
```` | ||
````` |
This file was deleted.
Oops, something went wrong.