Skip to content

Commit

Permalink
Update install instructions in README
Browse files Browse the repository at this point in the history
  • Loading branch information
Carlos Pascual committed Dec 24, 2022
1 parent c76895a commit 18800f8
Showing 1 changed file with 13 additions and 37 deletions.
50 changes: 13 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,55 +9,31 @@ Home page: https://github.com/cpascual/PAScual

## Installation instructions for PAScual


The **recommended way** of installing PAScual is by using a virtual environment where all needed dependencies are installed using [mamba](https://mamba.readthedocs.io). For this, first [install mamba](https://mamba.readthedocs.io/en/latest/installation.html) and then, on a terminal, run:

```
mamba create -c conda-forge -n PAScual python=2 pythonqwt pyqt numpy scipy
mamba activate PAScual
```

> **Note**: Using other conda implementations such as [Anaconda](https://www.anaconda.com) should also work, but I found mamba **a lot** faster. Replace `mamba` by `conda` if you are using Anaconda or miniconda instead of mamba.

Once the requirements are installed, **and in the same terminal** (or a terminal where you alsready activated the PAScual environment), you can install PAScual with:
PAScual and all its dependencies can be installed simply by running the following in a terminal of a system where [Python](https://www.python.org/) >=3.7 is installed:

```
pip install PAScual
```

### Alternative: manual installation of PAScual


> **Note**: I strongly recommended installing using a mamba (or conda) environment (as described above), specially for Windows users.
However, **I strongly recommend installing it in some sort of virtual python environment**.

If for some reason you cannot install with the recommended way, here are generic instructions to install it (but note that you may run into more trouble to get the proper versions of all the requirements).
For example, you can use [venv](https://docs.python.org/3/library/venv.html), but my
preferred choice is using [mamba](https://mamba.readthedocs.io). For this, first
[install mamba](https://mamba.readthedocs.io/en/latest/installation.html) and then,
on a terminal, run:

For running PAScual, at least the following packages **and all their dependencies** should
be installed:

- Python >=2.7
- Numpy >=1.0.3
- scipy >=0.5.2
- PyQt >=5
- PythonQwt >=0.5.5

For getting graphical output in the text mode interface, you may want

- matplotlib >= 0.90.1

Except for PythonQwt, the rest of the packages should be available in the
official repositories of any linux distribution that supports Python2.7.

For PythonQwt, you may need to use [PyPI](pypi.python.org)
```
mamba create -c conda-forge -n PAScual pythonqwt pyqt numpy scipy
Once the requirements are properly installed, you can install PAScual with:
mamba activate PAScual
```
pip install PAScual
```

> **Note**: Using other conda implementations such as [Anaconda](https://www.anaconda.com) is also possible, but I found mamba **a lot** faster. Replace `mamba` by `conda` if you are using Anaconda or miniconda instead of mamba.
> **Note** If you intend to use PAScual **in text mode**, you may want to also install `matplotlib` to produce plots.

## Running PAScual

Expand Down

0 comments on commit 18800f8

Please sign in to comment.