Metadata-Version: 2.4
Name: es_sfgtools
Version: 0.1.1b2
Summary: Utilities for translating and processing Seafloor Geodesy data
Author-email: Mike Gottlieb <mike.gottlieb@earthscope.org>, Franklyn Dunbar <franklyn.dunbar@earthscope.org>, Rachel Akie <rachel.akie@earthscope.org>
Project-URL: Homepage, https://github.com/EarthScope/es_sfgtools
Project-URL: ReadTheDocs, https://es-sfgtools.readthedocs.io/en/latest/
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: pandas
Requires-Dist: matplotlib
Requires-Dist: scikit-learn
Requires-Dist: julian
Requires-Dist: pandera==0.20.3
Requires-Dist: pyarrow
Requires-Dist: pydantic
Requires-Dist: pyproj
Requires-Dist: pymap3d
Requires-Dist: boto3
Requires-Dist: botocore
Requires-Dist: tqdm
Requires-Dist: sqlalchemy
Requires-Dist: python-dotenv
Requires-Dist: tiledb
Requires-Dist: seaborn
Requires-Dist: earthscope-sdk==1.1.0
Requires-Dist: earthscope-cli==1.0.1
Requires-Dist: gnatss
Requires-Dist: regex
Requires-Dist: cloudpathlib[s3]
Provides-Extra: dev
Requires-Dist: sphinx; extra == "dev"
Requires-Dist: sphinx-rtd-theme; extra == "dev"
Requires-Dist: myst-parser; extra == "dev"
Requires-Dist: sphinxcontrib-apidoc; extra == "dev"
Requires-Dist: sphinx_pyproject; extra == "dev"
Provides-Extra: notebook
Requires-Dist: ipykernel; extra == "notebook"
Dynamic: license-file

# EarthScope Seafloor Geodesy Tools

`es_sfgtools` is a Python library designed to support preprocessing and GNSS-A processing workflows for Seafloor Geodesy using data from Liquid Robotics SV2/SV3 Wave Gliders.  

The toolkit also integrates with the [**GARPOS**](https://github.com/s-watanabe-jhod/garpos) GNSS-A processing.

Due to a dependency of GARPOS, the library currently is only installable via conda.  Also GARPOS installation requires gfortran, which (if you dont already have it) can be installed on a mac with the command
> brew install gfortran

## Installation  

1. Clone the repository

    ```bash
    git clone https://github.com/EarthScope/es_sfgtools.git
    cd es_sfgtools
    ```

2. Create and activate a Conda environment

    Choose the environment file appropriate for your operating system.

    **macOS**

    ```bash
    conda env create -f mac_environment.yml
    conda activate seafloor_geodesy_mac
    ```

    **linux**

    ```bash
    conda env create -f linux_environment.yml
    conda activate seafloor_geodesy_mac
    ```

    These environment files provide all required scientific and compiler dependencies.

    **macOS TileDB Note (DYLD path)**

    In order to run parts of the library dependent on TileDB, you may also need to set the following environmental variable (use the correct path to your conda environment lib folder)

    `export DYLD_LIBRARY_PATH="/path/to/conda/env/lib"`

    For example:
    `export DYLD_LIBRARY_PATH="$HOME/miniconda3/envs/seafloor_geodesy_mac/lib"`

## Documentation

Documentation (in development) is available on ReadTheDocs:

[ReadTheDocs](https://es-sfgtools.readthedocs.io/en/latest/)

## Repository Files & Dependency Notes

* `linux_environment.yml`
  * Conda environment specification for Linux.

* `mac_environment.yml`
  * Conda environment specification for macOS.
  * Includes macOS compiler toolchain (clang, gfortran).

* `pyproject.toml`
  * Defines Python package metadata for PyPI distribution.
  * Conda environment installs from this.

* `requirements-dev.txt`
  * dev requirements pointed to by pyproj.toml

* `docs/requirements.txt`
  * Documentation build dependencies (Sphinx, RTD theme, myst-parser).

## Versioning

This project uses setuptools_scm for automatic versioning from git tags. Version information is generated at build time.

---

**Maintainers**: Mike Gottlieb, Franklyn Dunbar, Rachel Akie
**Organization**: [EarthScope](https://www.earthscope.org/)
