Installation, Testing & DevInfo¶
This page details installation instructions, how to run the tests, and some additional information if you want to develop new features for LASIF 2.0. If you encounter any issues, please don’t hesitate to contact us or open an issue on GitHub.
LASIF 2.0 is a Python based program and has a number of dependencies which are listed here. It might well work with other versions but only the versions listed here have been tested and are officially supported. It has been tested on Linux and Mac OS X but should also run just fine on Windows.
If you know what you are doing, just make sure these dependencies are
available, otherwise please do yourself a favor and download the Anaconda Python distribution, a free package
containing almost all dependencies. Download it, install it, and follow the
upcoming instructions. It will install LASIF into a separate
environment. This is very useful to separate the installation from the rest of
your system. Additionally it does not require root privileges and thus can be
installed almost everywhere.
# Sometimes you need the newest version of conda to install packages $ conda update conda # Locate yourself in the directory where you want to install LASIF $ git clone https://github.com/dirkphilip/LASIF_2.0.git $ cd LASIF_2.0 # Create a new conda environment which will here be called "lasif". $ conda env create -f environment.yml # Activate the lasif environment. This will always be needed when LASIF is started. $ source activate lasif
The actual LASIF module can then be installed with
# cd into the LASIF_2.0 directory $ pip install -v -e .
After the installation one should run the tests to ensure everything is installed correctly and works as intended on your machine.
LASIF evolved into a fairly complex piece of code and extensive testing is required to assure that it works as expected.
Running the Tests¶
To run the tests, cd into the toplevel
LASIF_2.0 directory and execute:
This will recursively find and execute all tests below the current working directory.
No errors should occur. If you see nothing - make sure your MPI installation is correct (see above).
Assuming your machine has multiple cores, the test can also be sped up
quite a bit by using
pytest-xdist which can be installed via pip.
$ pip install pytest-xdist
It enables to distribute the tests across cores. To run on, for example, eight cores, use
$ py.test -n 8
To update LASIF 2.0, change into the LASIF 2.0 directory and type
$ git pull $ pip install -v -e .
The following rules should be followed when developing for LASIF 2.0:
LASIF 2.0 is written entirely in Python 3.7.
Document the code.
Adhere to PEP8.
All contributed code must be contributed under the GPLv3.
Write tests where reasonable.
LASIF 2.0 utilizes Travis CI for continuous integration testing. This means that every commit will be automatically tested and the responsible developer will receive an email in case her/his commit breaks LASIF 2.0.
The tests also verify the PEP8 conformance of the entire code base.
In order to ease development, a consistent terminology should be used throughout the code base.
Assume a channel with a SEED identifier being equal to NET.STA.LOC.CHA, then the separate components should be called:
network_code or network: NET
station_code or station: STA
location_code or location: LOC
channel_code or channel: CHA