Metadata-Version: 2.4
Name: likeness_vitals
Version: 1.4.9
Summary: Shared utility functionality for Likeness modules.
Author-email: "James D. Gaboardi" <gaboardijd@ornl.gov>, "Jospeh V. Tuccillo" <tuccillojv@ornl.gov>
Maintainer: James D. Gaboardi, Jospeh V. Tuccillo
Project-URL: Home, https://github.com/likeness-pop
Project-URL: Repository, https://github.com/likeness-pop/likeness-vitals
Keywords: population-synthesis-utilities
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Requires-Dist: certifi>=2025.10.5
Requires-Dist: geopandas>=1.1
Requires-Dist: numpy>=1.26
Requires-Dist: pandas>=2.2
Requires-Dist: scipy>=1.12
Requires-Dist: shapely>=2.0
Requires-Dist: tqdm>=4.63
Requires-Dist: matplotlib>=3.7.1
Provides-Extra: tests
Requires-Dist: pre-commit; extra == "tests"
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytest-cov; extra == "tests"
Requires-Dist: pytest-xdist; extra == "tests"
Requires-Dist: ruff; extra == "tests"
Requires-Dist: setuptools_scm; extra == "tests"
Provides-Extra: notebooks
Requires-Dist: matplotlib; extra == "notebooks"
Requires-Dist: watermark; extra == "notebooks"
Provides-Extra: all
Requires-Dist: likeness_vitals[notebooks,tests]; extra == "all"
Dynamic: license-file

# Likeness-Vitals: Shared utilities for the Likeness ecosystem

![tag](https://img.shields.io/github/v/release/likeness-pop/likeness-vitals?include_prereleases&sort=semver)
[![PyPI version](https://badge.fury.io/py/likeness-vitals.svg)](https://badge.fury.io/py/likeness-vitals)
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/likeness_vitals.svg)](https://anaconda.org/conda-forge/likeness_vitals)

[![Continuous Integration](https://github.com/likeness-pop/likeness-vitals/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/likeness-pop/likeness-vitals/actions/workflows/continuous_integration.yml)
[![codecov](https://codecov.io/gh/likeness-pop/likeness-vitals/branch/develop/graph/badge.svg)](https://codecov.io/gh/likeness-pop/likeness-vitals)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

## Installation

### Conda-forge (recommended)

The `likeness-vitals` feedstock is available via the [conda-forge channel](https://github.com/conda-forge/likeness_vitals-feedstock).

```
$ conda install --channel conda-forge likeness_vitals
```

### PyPI

`likeness-vitals` is available on the [Python Package Index](https://pypi.org/project/likeness-vitals/).

```
$ pip install likeness_vitals
```

### Source

#### Directly via GitHub + `pip`

```
$ pip install git+https://github.com/likeness-pop/likeness-vitals.git@develop
```

#### Download + `pip`

Download the source distribution (``.tar.gz``) and decompress where desired. From that location:

```
$ pip install .
```

## Development

1. Clone the repository to the desired location.
2. Install in editable mode
   * Navigate to where the repo was cloned locally.
   * Within that directory:
      ```
      $ pip install -e .
      ```
3. Open an Issue for discussion
4. In a branch off `develop`, implement update/bug fix/etc.
5. Create a minimal Pull Request with clear description linked back to the associated issue from (3.)
6. Wait for review from maintainers
7. Adjust as directed
8. Once merged, fetch down `origin/develop` and merge into the local `develop`
9. Delete the branch created in (4.)
10. Start over at (2.)

## Ecosystem-level conda environments

The conda environments provided in `./envs/*` contain all dependencies required to use `livelike`, `pymedm` / `pmedm-legacy`, and `likeness-vitals`.

The install script will create a Python 3.12 environment and automatically choose between the vanilla and CUDA environment based on system type. To run it:

```
bash setup.sh
```

If a newer version of Python is desired, simply update `setup.sh` appropriately, though the CUDA version may not be available.
