Installation
SourceSpec requires at least Python 3.7. All the required dependencies will be downloaded and installed during the setup process.
Installing the latest release
Using Anaconda
The following command will automatically create an Anaconda
environment named sourcespec
, install the required packages and install the latest
version of SourceSpec via pip
:
conda env create --file https://raw.githubusercontent.com/SeismicSource/sourcespec/main/sourcespec_conda_env.yml
If you want a different name for your environment, use:
conda env create -n YOUR_ENV_NAME --file https://raw.githubusercontent.com/SeismicSource/sourcespec/main/sourcespec_conda_env.yml
Activate the environment with:
conda activate sourcespec
(or conda activate YOUR_ENV_NAME
)
To keep SourceSpec updated run:
pip install --upgrade sourcespec
from within your environment.
Using pip and PyPI
The latest release of SourceSpec is available on the Python Package Index.
You can install it easily through pip
:
pip install sourcespec
To upgrade from a previously installed version:
pip install --upgrade sourcespec
From SourceSpec GitHub releases
Download the latest release from the releases
page, in
zip
or tar.gz
format, then:
pip install sourcespec-X.Y.zip
or
pip install sourcespec-X.Y.tar.gz
Where, X.Y
is the version number (e.g., 1.2
). You don’t need to
uncompress the release files yourself.
Installing a developer snapshot
If you need a recent feature that is not in the latest release (see the “unreleased” section in SourceSpec Changelog), you want to use the more recent development snapshot from the SourceSpec GitHub repository.
Using pip
The easiest way to install the most recent development snapshot is to download
and install it through pip
, using its builtin git
client:
pip install git+https://github.com/SeismicSource/sourcespec.git
Run this command again, from times to times, to keep SourceSpec updated with the development version.
Cloning the SourceSpec GitHub repository
If you want to take a look at the source code (and possibly modify it 😉),
clone the project using git
:
git clone https://github.com/SeismicSource/sourcespec.git
or, using SSH:
git clone git@github.com:SeismicSource/sourcespec.git
(avoid using the “Download ZIP” option from the green “Code” button, since version number is lost).
Then, go into the sourcespec
main directory and install the code in
“editable mode” by running:
pip install -e .
You can keep your local SourceSpec repository updated by running git pull
from times to times. Thanks to pip
’s “editable mode”, you don’t need to
reinstall SourceSpec after each update.