Likeness-Vitals: Shared utilities for the Likeness ecosystem

Installation

Conda-forge (recommended)

The likeness-vitals feedstock is available via the conda-forge channel.

$ conda install --channel conda-forge likeness_vitals

PyPI

likeness-vitals is available on the Python Package Index.

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

Citation

If you find this package useful or use it an academic publication, please cite as:

• Tuccillo, J.V. and Gaboardi, J.D. (2025) likeness-vitals. Computer Software. URL: https://github.com/likeness-pop/likeness-vitals. DOI: 10.11578/dc.20250320.6