Skip to content

Commit 8031fed

Browse files
authored
Update README.md to reflect updates
1 parent e191bf5 commit 8031fed

File tree

1 file changed

+4
-96
lines changed

1 file changed

+4
-96
lines changed

README.md

Lines changed: 4 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,6 @@ To access the most recent release, see "Releases" on the sidebar. Download the a
6161
- The default installation directory is usually something like `C:\Users\<user>\AppData\Local\silt`
6262
- Find and run the silt program: Execute (double click) the `launch_silt.bat` file in the folder
6363

64-
### Notes to keep in mind
65-
- You may encounter Conda errors when you run `launch_silt.bat` if Conda is not added to the PATH environment variable. To fix, you can either 1) add Conda to PATH (generally not recommended), or 2) open the "Anaconda Powershell Prompt" terminal, navigate to the default installation directory, and run `launch_silt.bat`. The script will then find Conda.
66-
6764
- Please do not move `launch_silt.bat` or `run_tests.bat` to a different location (moving the entire folder as a whole is okay).
6865

6966
- (optionally) You may run the tests any time to make sure the program works properly. If you encounter errors, please try runing these tests: Execute `run_tests.bat` in the installation folder (done automatically on installation).
@@ -89,102 +86,13 @@ Note: this assumes conda is already installed on your system before hand
8986
- Run the program to open the GUI: Simply run the new command `silt`
9087

9188

92-
# Repository Installation
93-
## Prerequisites
94-
95-
- python >= 3.6 and < 3.9
96-
- numpy >= 1.15
97-
- pyqt5
98-
- h5py >= 2.8
99-
- shapely >= 1.6.4
100-
- pytest >= 8.2.0
101-
- pytest-qt
102-
- pytest-xvfb
103-
- pytest-cov
104-
- pytest-mock
105-
- scipy
106-
107-
*Note: the SILT package is set up to be installed with pip, therefore pip is
108-
also a requirement; however, pip is included within Python installations for
109-
Python versions >= 3.4.*
110-
111-
*Note: the versions of the prerequisites listed here are based on what I've
112-
personally tested. SILT may still function with other versions... but I haven't
113-
tested it.*
114-
115-
My recommendation is to use Anaconda environments. See [https://docs.anaconda.com/anaconda/install/](https://docs.anaconda.com/anaconda/install/).
116-
117-
I've had reports of issues installing PyQt5 outside of Anaconda environments. If you choose not to use Anaconda, then
118-
for Ubuntu, try:
119-
```bash
120-
sudo apt-get install python3-pyqt5
121-
```
122-
123-
or for RHEL:
124-
```bash
125-
yum install PyQt5
126-
```
127-
128-
on Windows with Python >= 3.6, I *think* you should be able to:
129-
```python
130-
pip install pyqt5
131-
```
132-
133-
## Installation
134-
135-
0. Install prerequisites
136-
137-
If you're using Anaconda environments for Python, that's just:
138-
```bash
139-
conda install pyqt numpy h5py shapely pytest pytest-qt pytest-xvfb pytest-cov pytest-mock scipy
140-
```
141-
Otherwise use the installer of your choice.
142-
143-
1. Clone the repo
144-
145-
```bash
146-
git clone git@github.com:sandialabs/SILT.git SILT
147-
```
148-
149-
2. Change to top-level directory
150-
151-
```bash
152-
cd SILT
153-
```
154-
155-
The directory structure should look like:
156-
157-
```bash
158-
SILT
159-
├── preview/
160-
├── README.md
161-
├── sample_images/
162-
├── sample_templates/
163-
├── scripts/
164-
├── silt/
165-
...
166-
```
167-
168-
3. Install silt
169-
170-
This package is set up to be installed via pip:
171-
172-
``` bash
173-
pip install ./silt
174-
```
175-
176-
4. To run SILT, simply call 'silt' from the command line
177-
178-
``` bash
179-
silt
180-
```
181-
182-
---
89+
# Installation
90+
SILT comes "batteries-included" which means that all the needed environments, libraries, and packages, come included. SILT is packaged using the Anaconda Constructor tool, which is the same packing tool that is used to distribute Anaconda itself. Since SILT is a fully packaged tool, it will not interact with your personal conda or python enviroments. SILT was designed to be be used in stand-alone systems, so it is all self contained.
18391

18492
## Recent Updates
18593

186-
#### 2.2.0
187-
- Images can be loaded as an image pyramid, saving memory.
94+
#### 2.2.0 "Feldspar"
95+
- Images can be loaded as an image pyramid, saving memory. Minor issues fixed with the Windows and Linux Installers
18896

18997
#### 2.1.0
19098
- Polygon lines no longer scale with the scene when zooming.

0 commit comments

Comments
 (0)