lvmcam’s documentation#

This is the documentation for the SDSS Python product lvmcam. The current version is 0.4.13a0.

Versions Test Documentation Status codecov

Quick Start#

Clone the repository.

$ git clone https://github.com/sdss/lvmcam
$ cd lvmcam

Run install script.

$ $SHELL install.sh

Install pyenv by using pyenv installer.

$ curl https://pyenv.run | bash

You should add the code below to ~/.bashrc or ~/.zshrc by using your preferred editor.

# pyenv
export PYENV_ROOT="$HOME/.pyenv"
export PATH="$PYENV_ROOT/bin:$PATH"
eval "$(pyenv init -)"
eval "$(pyenv init --path)"
eval "$(pyenv virtualenv-init -)"

Set the python 3.8+ virtual environment.

$ pyenv install 3.8.12
$ pyenv virtualenv 3.8.12 lvmcam-with-3.8.12
$ pyenv local lvmcam-with-3.8.12

Install poetry and dependencies.

$ pip install --upgrade pip
$ pip install poetry
$ poetry install

Start lvmcam actor.

$ poetry run container_start --kill --name=lvm.cam

In another terminal, type clu and lvm.cam ping for test.

$ clu
lvm.cam ping
    07:41:22.636 lvm.cam >
    07:41:22.645 lvm.cam : {
        "text": "Pong."
        }

If errors occur when running $ poetry run ..., run a command below to check whether there are some lvmcam containers.

$ podman ps -a

If there are some containers, run a command below to delete a specific container.

$ podman rm -f <CONTAINER ID>

If the error similar to below occurs, check whether python/lvmcam/etc/<ActorName>.yml is empty.

TypeError: __init__() missing 1 required positional argument: 'name'

All children are gone. Parent is exiting...