Skip to content

Commit 99f7c1b

Browse files
committed
address some comments
1 parent 8975d95 commit 99f7c1b

3 files changed

Lines changed: 27 additions & 6927 deletions

File tree

INSTALL.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Whether you're installing SasView to use as a tool for your research or
44
because you're wanting to work on the code, it is recommended that you
55
work inside a Python virtual environment of some sort.
6-
A `venv` or a `conda` are both popular choices.
6+
A `venv` or a `Pixi` are both popular choices.
77

88
## Installing SasView as a User
99

@@ -94,8 +94,7 @@ debugging software, e.g.:
9494
An alternative to `venv` is the package management tool Pixi. If Pixi is not
9595
installed, follow the instructions [here](https://pixi.prefix.dev/latest/#installation).
9696

97-
To start developing using Pixi, download the repos and enter the shell into
98-
the development environment:
97+
The very quick version for developing using Pixi is:
9998

10099
```shell
101100
# Clone the repository
@@ -109,7 +108,7 @@ cd sasview
109108
pixi shell
110109

111110
# Start the GUI
112-
sasview
111+
python -m sas
113112

114113
# Run tests
115114
pixi run test
@@ -118,8 +117,29 @@ pixi run test
118117
exit
119118
```
120119

121-
Note that `sasdata`, `sasmodels` and `sasview` are installed in editable mode,
122-
meaning that any changes are immediately available during development.
120+
In more detail, the steps are:
121+
122+
1. Obtain the SasView source using `git`. You will likely need to coordinate
123+
updates to `sasdata` and `sasmodels`. The
124+
[`bumps`](https://github.com/bumps/bumps) and
125+
[`periodictable`](https://github.com/python-periodictable/periodictable)
126+
packages are far more loosely coupled, but depending on what you are
127+
doing you may also want them as development packages, in which case they
128+
need to be added as editable in the section `[tool.pixi.pypi-dependencies]`
129+
in `pyproject.toml`.
130+
1. Create (or reuse) a local Pixi environment in `.pixi` and enter the shell
131+
into the developer environment. The first time it will take a while to
132+
download and unpack all dependencies.
133+
Note that `sasdata`, `sasmodels` and `sasview` are installed in editable mode,
134+
meaning that any code changes will be available the next time you run the
135+
program.
136+
1. Run SasView! As an alternative to typing `python -m sas`, you can simply
137+
type `sasview`.
138+
139+
Almost all the modules that SasView needs are available as precompiled modules
140+
on PyPI, including numpy, scipy, h5py, pyside6. A handful of Python-only
141+
modules will be built into wheels on your local machine. Installing the
142+
dependencies should be a one-off task.
123143

124144
## Pre-Commit Hooks for Linting
125145

0 commit comments

Comments
 (0)