Skip to content

Commit

Permalink
Merge pull request #494 from scipp/update-install-instructions
Browse files Browse the repository at this point in the history
Update installation instructions
  • Loading branch information
jl-wynen authored Feb 8, 2024
2 parents 6b41fc6 + 22a3c4e commit 686eb9c
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 111 deletions.
18 changes: 7 additions & 11 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,18 @@
# ScippNeutron

<span style="font-size:1.2em;font-style:italic;color:#5a5a5a">
Neutron scattering tools for Data Reduction powered by [Scipp](https://scipp.github.io/).
Neutron scattering tools for Data Reduction powered by Scipp.
</br></br>
</span>

:::{include} user-guide/installation.md
:heading-offset: 1
:::

## Where can I get help?
## Get in touch

For questions not answered in the documentation,
[this page](https://github.com/scipp/scippneutron/issues?utf8=%E2%9C%93&q=label%3Aquestion)
provides a forum with discussions on problems already met/solved in the community.

New questions can be asked by
[opening](https://github.com/scipp/scippneutron/issues/new?assignees=&labels=question&template=question.md&title=)
a new 'question' issue.

## Documentation
- If you have questions that are not answered by these documentation pages, ask on [GitHub discussions](https://github.com/orgs/scipp/discussions). Please include a self-contained reproducible example if possible.
- Report bugs (including unclear, missing, or wrong documentation!), suggest features or view the source code [on GitHub](https://github.com/scipp/scippneutron).

```{toctree}
---
Expand Down
36 changes: 36 additions & 0 deletions docs/user-guide/installation.md
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
```
````
`````
100 changes: 0 additions & 100 deletions docs/user-guide/installation.rst

This file was deleted.

0 comments on commit 686eb9c

Please sign in to comment.