noisepy-seis-io 0.1.14

No project description provided

noisepy-seis-io

This project was automatically generated using the LINCC-Frameworks python-project-template.

A repository badge was added to show that this project uses the python-project-template, however it's up to you whether or not you'd like to display it!

For more information about the project template see the documentation.

Dev Guide - Getting Started

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 <env_name> python=3.10
>> conda activate <env_name>

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:

1. 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.

2. Installing in Editable mode:

>> pip install -e .[dev]

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.
• Install the package in editable mode by running pip install -e .[dev].
• Any additional steps or workarounds specific to this scenario can be added here.

3. Installing without Editable Mode:

>> pip install .[dev]

Install pre-commit hook and pandoc:

>> pre-commit install
>> conda install pandoc

Notes:

1. 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
2. Install pandoc allows you to verify that automatic rendering of Jupyter notebooks into documentation for ReadTheDocs works as expected. For more information, see the Python Project Template documentation on Sphinx and Python Notebooks