Skip to content

Latest commit

 

History

History
248 lines (183 loc) · 5.34 KB

README.md

File metadata and controls

248 lines (183 loc) · 5.34 KB

seed-vault

Example of Step 1

Seed Vault is a cross platform GUI utility which can search, view and download seismic FDSN data

  • Users can download data via earthquake search (station to event, or event to station)
  • View and download bulk continuous data
  • Search and save earthquake events and station metadata.
  • Download restricted data
  • Caches downloaded data in a local database to speed up future retrievals
  • Local database editor
  • Load and save search parameters and configuration

Runs on:

  • Linux
  • Windows
  • MacOS

Can run:

  • As web service
  • From the command line (CLI)

Requirements

  • 8 GB RAM
  • Python >= 3.10
  • ObsPy (>=1.4.1), Streamlit (>=1.39), Plotly (>-5.24), Pandas (>=2.2.2), Matplotlib (>=3.8.5)

Install via pip

$ python3 pip install seed-vault

Install from source

Step 1: Clone repository

git clone https://github.com/AuScope/seed-vault.git

or

git clone [email protected]:AuScope/seed-vault.git

Step 2: Setup and run

The app requires python >=3.10. For a quick start follow these steps:

git clone https://github.com/AuScope/seed-vault.git
cd seed-vault

Linux/MacOS

source setup.sh
source run.sh

Windows

Open a powershell and run following commands:

.\setup-win.ps1
.\run-win.ps1

NOTES:

  1. For Win OS, you would need to convert the shell scripts to PowerShell. Or simply follow the steps in the shell scripts to set up the app.
  2. Requires python3 venv software package e.g. For python v10 on Ubuntu you may need to: 
    sudo apt update
sudo apt install python3.10-venv

Development

Project Folder structure

seed-vault/
│
├── seed_vault/      # Python package containing application code
│   ├── models/        # Python modules for data models
│   ├── service/       # Services for logic and backend processing
│   ├── ui/            # UI components (Streamlit files)
│   ├── utils/         # Utility functions and helpers
│   ├── __init__.py    # 
│   └── cli.py         # Command Line Interface
│
└── pyproject.toml     # Poetry configuration file for the whole project

Setting up with Poetry

If you look to further develop this app, it is highly recommended to set up the project with poetry. Follow the steps below to set up using poetry.

Install poetry

Refer to this link: https://python-poetry.org/docs/

Alternatively,

Linux

curl -sSL https://install.python-poetry.org | python3 -

then, add following to .bashrc:

export PATH="$HOME/.local/bin:$PATH"

Windows powershell:

(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | python -

then, add poetry to your system path. It should be located here:

%USERPROFILE%\.poetry\bin

Optional To configure poetry to create .venv inside project folder, run following:

poetry config virtualenvs.in-project true

Install pyenv (Optional)

This project uses python 3.12.*. If your base python is a different version (check via python --version), you may get errors when trying to install via poetry. Use pyenv to manage this.

Linux

Install the required packages for building Python with the following command

sudo apt update

sudo apt install -y build-essential libssl-dev zlib1g-dev libbz2-dev
libreadline-dev libsqlite3-dev wget curl llvm libncurses5-dev libncursesw5-dev
xz-utils tk-dev libffi-dev liblzma-dev git

Then, install pyenv

curl https://pyenv.run | bash

After installation, add following to .bashrc:

export PATH="$HOME/.pyenv/bin:$PATH"

eval "$(pyenv init --path)"

eval "$(pyenv init -)"

Run .bashrc to get things updated: source ~/.bashrc

Start the project

Install python 3.12.* if you have a different version locally:

pyenv install 3.12.0

pyenv global 3.12.0

Confirm your python version: python --version

Install the packages using following.

poetry install

Start the project:

poetry shell

To run the app:

streamlit run seed_vault/ui/main.py

Alternatively, command line is configured for this project. You can also run the app, simply by:

seed-vault start

Build Project

Build Python Library

poetry build

Build Installers

Need to be added

Docker Development

To develop and run the application using Docker, follow these steps:

Prerequisites

  • Install Docker Application on your system

Build and Run the Docker Container

  1. Navigate to the project root directory:
cd seed-vault
  1. Build and run the Docker container:
docker compose up --build

The application should now be running and accessible at http://localhost:8501.

Export poetry packages to requirements.txt

poetry export -f requirements.txt --output requirements.txt --without-hashes

Publishing the lib to test: pypi

Define a package name in pyproject.toml (e.g. seed-vault). Then, run following commands

poetry build
poetry config repositories.testpypi https://test.pypi.org/legacy/
poetry config pypi-token.test-pypi <YOUR PYPI TOKEN>
poetry publish -r testpypi

To install from pypi-test:

pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple seed-vault

Note: include both test and official indexes.