Commit ecab6edc authored by karpov-sv's avatar karpov-sv
Browse files

Improve installation documentation

parent 996cf425
......@@ -37,15 +37,16 @@
*STDpipe* is available at https://github.com/karpov-sv/stdpipe and is mirrored at https://gitlab.in2p3.fr/icare/stdpipe
You may either install it from GitHub directly as
The package is in constant development, so to keep track of the changes the suggested way of installing it is by cloning the repository
```
python3 -m pip install --user git+https://github.com/karpov-sv/stdpipe
git clone https://github.com/karpov-sv/stdpipe
```
or better clone the repository and then execute
and then installing from it in development (or "editable") mode by running the command
```
python3 setup.py develop --user
```
to install the package in development (or "editable") mode. This way you may update the repository or apply local patches, and it will immediately be reflected in the installed package.
This way you may update the repository or apply local patches, and it will immediately be reflected in the installed package.
Apart of Python requirements that will be installed automatically, *STDPipe* also (optionally) makes use of the following external software:
......@@ -60,6 +61,8 @@ Most of them may be installed from your package manager. E.g. on Debian or Ubunt
sudo apt install sextractor scamp psfex swarp
```
You may also check more detailed installation instructions [here](https://stdpipe.readthedocs.io/en/latest/installation.html).
# Usage
The [documentation for *STDPipe*](https://stdpipe.readthedocs.io/) is now being actively written. In the meantime you may check the examples inside [notebooks/](notebooks/) folder, especially the [tutorial](notebooks/stdpipe_tutorial.ipynb) that demonstrates basic steps of a typical image processing.
......@@ -15,9 +15,9 @@ Ubuntu 20.04 is available for free download on Microsoft Store.
You may safely skip these steps if you already have a working Python environment where you would like to install *STDPipe*.
**Installing Anaconda3**
**Installing Anaconda**
On your Linux/MacOS/WSL terminal, run the following commands to install anaconda (replace 5.3.1 by the latest version, and adjust operating system name):
On your Linux/MacOS/WSL terminal, run the following commands to install [Anaconda](https://www.anaconda.com) (replace 5.3.1 by the latest version, and adjust operating system name):
* $ wget https://repo.anaconda.com/archive/Anaconda3-5.3.1-Linux-x86_64.sh
......@@ -120,12 +120,18 @@ This instruction file will likely cover the issues you might face during your in
- [HOTPANTS](https://github.com/acbecker/hotpants)
- [Astrometry.Net](https://github.com/dstndstn/astrometry.net)
Most of them are also available in the repositories of various Linux distributions, and may be conveniently installed from there
Most of them are also available in the repositories of various Linux distributions, and may be conveniently installed from there (see below).
HOTPANTS image subtraction package cannot presently (as far as I know) be installed from any package manager, and has to be compiled manually.
### Ubuntu
* $ sudo apt install sextractor scamp psfex swarp
Astrometry.Net may also be installed from repository, but might require additional manual configuration steps (and quite a lot of disk space for larger indices!), so install it only when you really need it, and when you really know what you are doing!
* $ sudo apt install astrometry.net
### Anaconda
* $ conda install -f conda-forge astromatic-source-extractor astromatic-scamp astromatic-psfex astromatic-swarp
* $ conda install -c conda-forge astromatic-source-extractor astromatic-scamp astromatic-psfex astromatic-swarp
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment