Skip to content

Commit

Permalink
Rewrote the installation page
Browse files Browse the repository at this point in the history
  • Loading branch information
adam-iris committed Jul 26, 2024
1 parent 8143a67 commit 688ab37
Show file tree
Hide file tree
Showing 4 changed files with 63 additions and 84 deletions.
94 changes: 50 additions & 44 deletions Installation.md
Original file line number Diff line number Diff line change
@@ -1,85 +1,94 @@
# PyWEED Installation

PyWEED is distributed as an [anaconda](https://conda.io/docs/) package.
**Not compatible with Python 3.12**
Currently (2024-07-26) PyWEED cannot run under Python 3.12, due to unavailable dependencies.

Some troubleshooting information can be found in [Support](Support.md).

## Install Anaconda/Miniconda (if needed)

This is the conda package manager. Miniconda is a lighter version of Anaconda, and is recommended.

__[Miniconda Installers](https://conda.io/miniconda.html)__

This page includes both 2.x and 3.x versions, it's better to get the 3.x version. (It doesn't strictly matter, though.)

__Mac/Linux__: the installation process should put the `conda` command in your shell `PATH`.
__Windows__: launch the Anaconda Prompt application installed by Miniconda for the next steps.

## Install PyWEED

Run the following command:
PyWEED is most reliably installed using [conda](https://conda.io/docs/):

```
conda create -n pyweed -c conda-forge python=3 pyweed
conda install -c conda-forge pyweed
```

This creates a `pyweed` [environment](https://conda.io/docs/using/envs.html) in Anaconda, and installs Python 3, PyWEED,
and all associated dependencies from [conda-forge](https://github.com/conda-forge/) into that environment.

# Running PyWEED

__Mac/Linux__
For best results, create a dedicated environment:

```
conda activate pyweed
pyweed
conda create -n pyweed -c conda-forge pyweed
```

__Windows__ (from the Anaconda Prompt)
It can also be installed via pip, although you may need system libraries for some dependencies:

```
activate pyweed
pyweed
pip install pyweed
```

# Other Options

## Network Install
Some troubleshooting information can be found in [Support](Support.md).

__Mac/Linux only__
## Running PyWEED

This command should perform a complete installation:
PyWEED installs a `pyweed` script, so from the command line:

```
bash <(curl -Ss https://raw.githubusercontent.com/iris-edu/pyweed/master/installer/install.sh)
pyweed
```

This downloads and runs a script that essentially performs the steps outlined above.
## Other installation topics

## Clickable Application
### Clickable Application

__Mac/Windows only__
**Mac/Windows only**

This produces a small application that will launch PyWEED when clicked, suitable for adding to your Desktop
or launch bar.

__Mac__
**Mac**

```
conda activate pyweed
pyweed_build_launcher
mv PyWEED.app /Applications/
```

__Windows__
**Windows**

```
activate pyweed
pyweed_build_launcher
move PyWEED.bat Desktop
```

## Source Code
### Installing Anaconda/Miniconda

This is the conda package manager. Miniconda is a lighter version of Anaconda, and is recommended.

**[Miniconda Installers](https://conda.io/miniconda.html)**

(PyWEED requires **Python 3.11** or below!)

**Mac/Linux**: the installation process should put the `conda` command in your shell `PATH`.
**Windows**: launch the Anaconda Prompt application installed by Miniconda for the next steps.

You can

```
conda create -n pyweed -c conda-forge pyweed
```

This creates a `pyweed` [environment](https://conda.io/docs/using/envs.html) in Anaconda, and installs Python 3, PyWEED,
and all associated dependencies from [conda-forge](https://github.com/conda-forge/) into that environment.

### Network Install

**Mac/Linux only**

This command should perform a complete installation:

```
bash <(curl -Ss https://raw.githubusercontent.com/iris-edu/pyweed/master/installer/install.sh)
```

This downloads and runs a script that builds a conda environment and installs PyWEED into it. Note that this may auto-install various dependencies.

### Source Code

Clone the PyWEED repository with:

Expand All @@ -90,9 +99,6 @@ git clone https://github.com/iris-edu/pyweed.git
or [download as a zip file](https://github.com/iris-edu/pyweed/archive/master.zip) and unzip into a `pyweed` directory.

```
conda activate pyweed
cd pyweed
python run_pyweed.py
```


33 changes: 0 additions & 33 deletions PyInstaller.md

This file was deleted.

14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
## About PyWEED

**[Installation Guide](Installation.md)**

**[User Guide](UserGuide/index.md)**

**[Support](Support.md)**

PyWEED is an application for retrieving event-based seismic data.

PyWEED works on Windows, Mac, and Linux (64-bit). It is built on [ObsPy](https://obspy.org/) and
Expand All @@ -9,16 +15,10 @@ PyWEED works on Windows, Mac, and Linux (64-bit). It is built on [ObsPy](https:/

![Waveforms Window](WaveformsWindow.png)

[Demo Screencast](https://vimeo.com/246357529) on Vimeo
[Demo Screencast](https://vimeo.com/246357529) on Vimeo

## Documentation

__[Installation Guide](Installation.md)__

__[User Guide](UserGuide/index.md)__

__[Support](Support.md)__

Please send comments/problems to [[email protected]]([email protected]).

---
Expand Down
6 changes: 6 additions & 0 deletions Support.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Support

## PyWEED crashes on startup

The most common reason is a problem in the configuration file. This is located at `~/.pyweed/pyweed.ini`. If you move or delete it, PyWEED will recreate a fresh version the next time it starts.

## Install problems

Far and away the most common problem is library mismatches -- some of the libraries that PyWEED uses (ObsPy and Qt most notably) bring in a wide mix of their own dependencies, resulting in a complex mix of library versions.
Expand All @@ -11,9 +15,11 @@ This can be addressed by specifying PyWEED's direct dependencies in more granula
#### ImportError: cannot import name 'dedent' from 'matplotlib.cbook'

See [#119](https://github.com/iris-edu/pyweed/issues/119) -- in an existing environment running

```
conda install matplotlib=3.2
```

should install the correct package.

## Contact
Expand Down

0 comments on commit 688ab37

Please sign in to comment.