1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
# Quick Intro for Building SasView
Note - at the current time SasView will only run in gui form under Python 3.11
and later.
Whether you're installing SasView to use as a tool for your research or
because you're wanting to work on the code, it is recommended that you
work inside a Python virtual environment of some sort.
A `venv` or a `conda` are both popular choices.
## Installing SasView as a User
Installers for SasView can be found at [https://www.sasview.org/](https://www.sasview.org/), for various operating systems. You will also find
walk through tutorials on how to install and use SasView.
You can also install SasView using standard Python installation tools,
such as `pipx install sasview` to install it into its own standalone
environment (or `pip install sasview` to install it into your current Python
environment).
## Making a SasView Development Environment
If you're familiar with working with developing in Python, then the
very quick version is:
```shell
git clone https://github.com/sasview/sasdata/
git clone https://github.com/sasview/sasmodels/
git clone https://github.com/sasview/sasview/
cd sasview
python -m venv venv
# venv\Scripts\activate & REM Windows: activate environment
. venv/bin/activate # Linux/Mac: activate environment
pip install -e ../sasdata
pip install -e ../sasmodels
pip install -e .[dev,test]
python -m sas
```
Step by step, that is:
1. Obtain the SasView source using `git`. You will likely need to coordinate
updates to `sasdata` and `sasmodels`. The
`bumps` (https://github.com/bumps/bumps) and
`periodictable` (https://github.com/python-periodictable/periodictable)
packages are far more loosely coupled, but depending on what you are
doing you may also want them as development packages.
1. Create a Python virtual environment in the `venv` directory.
1. Activate the `venv` so that Python and its modules from the venv are used.
Note that the particular syntax above works for the `bash` and `zsh` shells under Linux, Windows and macOS;
if you use `cmd` or PowerShell under windows, there are
[different ways](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#create-and-use-virtual-environments)
to activate the virtual environment.
1. Install the necessary modules for building and running SasView.
It will take a while to download and unpack all the dependencies.
The `pip install -e` command says to install the package in development mode
so that any changes you make in the source tree will be available the
next time you run the program. The `.[dev,test]` syntax says to install
the current directory (sasview) with test and dev dependencies.
1. Build the GUI and the documentation using the `hatchling` builder.
1. Run SasView!
Almost all the modules that SasView needs are available as precompiled modules
on PyPI, including numpy, scipy, h5py, pyside6. A handful of Python-only
modules will be built into wheels on your local machine. Installing the
dependencies should be a one-off task.
When you want to work on SasView again at a later date, you can type:
```shell
# venv\Scripts\activate & REM Windows: activate environment
. venv/bin/activate # Linux/Mac: activate environment
python -m sas
```
(or the [equivalent command](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#create-and-use-virtual-environments) for your shell to activate the venv)
Note that many Python-focused integrated development environment programs have the
ability to activate the venv for you as part of the process of starting and
debugging software, e.g.:
- [VS Code](https://code.visualstudio.com/docs/python/environments)
- [PyCharm](https://www.jetbrains.com/help/pycharm/creating-virtual-environment.html)
If you've altered the user interface or want the documentation to be rebuilt,
then the `hatchling` step can be repeated.
More information can be found at:
- http://www.sasview.org/help
- http://www.sasview.org/faq
- https://github.com/SasView/sasview/wiki/DevNotes
|
