Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 2.27 KB

README.md

File metadata and controls

46 lines (30 loc) · 2.27 KB
Raw

noisepy-seis-io

PyPI codecov

This project was automatically generated using the LINCC-Frameworks python-project-template. For more information about the project template see the documentation.

Development Guide

Before installing any dependencies or writing code, it's a great idea to create a virtual environment. LINCC-Frameworks engineers primarily use conda to manage virtual environments. If you have conda installed locally, you can run the following to create and activate a new environment.

conda create env -n noisepy python=3.10
conda activate noisepy

Once you have created a new environment, you can install this project for local development and below are the recommended steps for setting up your environment based on different installation scenarios:

  • Installing from PyPI:

    pip install noisepy-seis

    If you're using pip install noisepy-seis to install the package directly from PyPI, all sources and dependencies will be placed in the appropriate site-packages directory. This setup is suitable for production environments and does not require additional setup for development.

  • Installing in Editable mode:

    If you're cloning the noisepy-seis repository and installing the development version in editable mode (-e flag), you can follow these steps:

    • Clone the noisepy-seis repository from GitHub git clone [email protected]:noisepy/noisepy-io.git.
    • Install the package in editable mode by running pip install -e .[dev].

  • Installing without Editable Mode:

    pip install .[dev]

  • Install pre-commit hook:

    pre-commit install

    Note that pre-commit install will initialize pre-commit for this local repository, so that a set of tests will be run prior to completing a local commit. For more information, see the Python Project Template documentation on pre-commit.