sdss-lvmtan


Namesdss-lvmtan JSON
Version 0.3.3 PyPI version JSON
download
home_pagehttps://github.com/sdss/lvmtan
SummaryLvm Tan Clu Wrapper
upload_time2024-03-11 12:46:57
maintainer
docs_urlNone
authorFlorian Briegel
requires_python>=3.8,<4
licenseBSD-3-Clause
keywords astronomy software
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # lvmtan

![Versions](https://img.shields.io/badge/python->3.7-blue)
[![Documentation Status](https://readthedocs.org/projects/sdss-lvmtan/badge/?version=latest)](https://sdss-lvmtan.readthedocs.io/en/latest/?badge=latest)
[![Travis (.org)](https://img.shields.io/travis/sdss/lvmtan)](https://travis-ci.org/sdss/lvmtan)
[![codecov](https://codecov.io/gh/sdss/lvmtan/branch/main/graph/badge.svg)](https://codecov.io/gh/sdss/lvmtan)

Lvm Tan Clu Wrapper

## Features

- CLU based wrapper for [TwiceAsNice](https://svn.mpia.de/trac/gulli/TwiceAsNice/)
- Uses a container for deployment and testing. 
- Uses podman¹ for building the container.

¹ Setting an alias to use docker might work.

    alias podman="sudo docker"
    
## Note

As of version 0.0.9 the container is renamed from ubuntu_lvmt_tan to lvmtan

## Quickstart
Beginning with version  0.0.9 the container doesnt have to be build, a container is download automatically from github.

    git clone https://github.com/sdss/lvmtan.git
    cd lvmtan      
    poetry run container_start --kill --name lvm.all

## Prerequisites

Some linux distributions do not have python >= 3.7 as the standard python3 version.

### Centos 8.X

    # as root
    yum install python38
    # as user 
    python3.8  -m pip  install --user --upgrade pip
    pip3.8 install poetry
    export PATH=~/.local/bin/:$PATH

### OpenSuSe 15.2/15.3

    # as root
    zypper ar https://download.opensuse.org/repositories/devel:/languages:/python:/Factory/openSUSE_Leap_15.2/ devel_python
    zypper install python39-devel
    # as user 
    python3.9 -m ensurepip --default-pip # Alternatve: python3.9 -m venv ~/.local 
    pip3.9 install --upgrade pip
    pip3.9 install poetry
    export PATH=~/.local/bin/:$PATH

For running tests or containers a running RabbitMQ on localhost is expected with guest/guest

## Download
    git clone https://github.com/sdss/lvmtan.git
    cd lvmtan      


## Build
    # update local py env
    poetry update
    
    # build sdist & wheel
    poetry build
    
    # build tan container
    poetry run container_build
    # rebuild tan container from scratch
    poetry run container_build --no-cache
        
## Run container

    # default config test.first.focus_stage-sim.conf
    poetry run container_start
    poetry run container_stop
    
    # all stages config lvm.all-sim.conf
    poetry run container_start --name lvm.all
    poetry run container_stop --name lvm.all
  
    # all stages config lvm.all-sim.conf and kill running container
    poetry run container_start --kill --name lvm.all

    # log of the running container, -f output appended data as the file grows.
    podman logs -f lvm.all

    # config test.first.focus_stage-svr.conf with real hardware
    poetry run container_start --with-hw
    poetry run container_stop
    
    # derotator km with real hardware - check confige file config/test/derot/test.derot.km-dev.conf for correct MOD.TRAJ.CFG.CONNECTION.ADDRESS and MOD.TRAJ.CFG.CONNECTION.MODULE parameters
    poetry run container_start --name test.derot.km --with-hw
    
    # debug option, the local version is used instead of the latest github version when the container was built.
    poetry run container_start --debug
    
## Run tests 

    # run tests
    poetry run pytest
    # ... include slow tests with enabled log to stdout
    poetry run pytest -p no:logging -s -v --runslow
    # ... only test 02
    poetry run pytest -k test_02_lvm_all.py
    # ... without UI
    DISPLAY= poetry run pytest -p no:logging -s -v -k test_02_lvm_all.py
    
    
## Publish
    # publish to pypi
    poetry publish --username=USER --password=PASS
    # build rpm package
    poetry run python setup.py bdist_rpm
    # build deb package - needs python3-stdeb
    poetry run python setup.py --command-packages=stdeb.command bdist_deb


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/sdss/lvmtan",
    "name": "sdss-lvmtan",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<4",
    "maintainer_email": "",
    "keywords": "astronomy,software",
    "author": "Florian Briegel",
    "author_email": "briegel@mpia.de",
    "download_url": "https://files.pythonhosted.org/packages/da/8f/1465c695a48b510148585a030bb5269d2667d23415cb10270c3bbba0f676/sdss_lvmtan-0.3.3.tar.gz",
    "platform": null,
    "description": "# lvmtan\n\n![Versions](https://img.shields.io/badge/python->3.7-blue)\n[![Documentation Status](https://readthedocs.org/projects/sdss-lvmtan/badge/?version=latest)](https://sdss-lvmtan.readthedocs.io/en/latest/?badge=latest)\n[![Travis (.org)](https://img.shields.io/travis/sdss/lvmtan)](https://travis-ci.org/sdss/lvmtan)\n[![codecov](https://codecov.io/gh/sdss/lvmtan/branch/main/graph/badge.svg)](https://codecov.io/gh/sdss/lvmtan)\n\nLvm Tan Clu Wrapper\n\n## Features\n\n- CLU based wrapper for [TwiceAsNice](https://svn.mpia.de/trac/gulli/TwiceAsNice/)\n- Uses a container for deployment and testing. \n- Uses podman\u00b9 for building the container.\n\n\u00b9 Setting an alias to use docker might work.\n\n    alias podman=\"sudo docker\"\n    \n## Note\n\nAs of version 0.0.9 the container is renamed from ubuntu_lvmt_tan to lvmtan\n\n## Quickstart\nBeginning with version  0.0.9 the container doesnt have to be build, a container is download automatically from github.\n\n    git clone https://github.com/sdss/lvmtan.git\n    cd lvmtan      \n    poetry run container_start --kill --name lvm.all\n\n## Prerequisites\n\nSome linux distributions do not have python >= 3.7 as the standard python3 version.\n\n### Centos 8.X\n\n    # as root\n    yum install python38\n    # as user \n    python3.8  -m pip  install --user --upgrade pip\n    pip3.8 install poetry\n    export PATH=~/.local/bin/:$PATH\n\n### OpenSuSe 15.2/15.3\n\n    # as root\n    zypper ar https://download.opensuse.org/repositories/devel:/languages:/python:/Factory/openSUSE_Leap_15.2/ devel_python\n    zypper install python39-devel\n    # as user \n    python3.9 -m ensurepip --default-pip # Alternatve: python3.9 -m venv ~/.local \n    pip3.9 install --upgrade pip\n    pip3.9 install poetry\n    export PATH=~/.local/bin/:$PATH\n\nFor running tests or containers a running RabbitMQ on localhost is expected with guest/guest\n\n## Download\n    git clone https://github.com/sdss/lvmtan.git\n    cd lvmtan      \n\n\n## Build\n    # update local py env\n    poetry update\n    \n    # build sdist & wheel\n    poetry build\n    \n    # build tan container\n    poetry run container_build\n    # rebuild tan container from scratch\n    poetry run container_build --no-cache\n        \n## Run container\n\n    # default config test.first.focus_stage-sim.conf\n    poetry run container_start\n    poetry run container_stop\n    \n    # all stages config lvm.all-sim.conf\n    poetry run container_start --name lvm.all\n    poetry run container_stop --name lvm.all\n  \n    # all stages config lvm.all-sim.conf and kill running container\n    poetry run container_start --kill --name lvm.all\n\n    # log of the running container, -f output appended data as the file grows.\n    podman logs -f lvm.all\n\n    # config test.first.focus_stage-svr.conf with real hardware\n    poetry run container_start --with-hw\n    poetry run container_stop\n    \n    # derotator km with real hardware - check confige file config/test/derot/test.derot.km-dev.conf for correct MOD.TRAJ.CFG.CONNECTION.ADDRESS and MOD.TRAJ.CFG.CONNECTION.MODULE parameters\n    poetry run container_start --name test.derot.km --with-hw\n    \n    # debug option, the local version is used instead of the latest github version when the container was built.\n    poetry run container_start --debug\n    \n## Run tests \n\n    # run tests\n    poetry run pytest\n    # ... include slow tests with enabled log to stdout\n    poetry run pytest -p no:logging -s -v --runslow\n    # ... only test 02\n    poetry run pytest -k test_02_lvm_all.py\n    # ... without UI\n    DISPLAY= poetry run pytest -p no:logging -s -v -k test_02_lvm_all.py\n    \n    \n## Publish\n    # publish to pypi\n    poetry publish --username=USER --password=PASS\n    # build rpm package\n    poetry run python setup.py bdist_rpm\n    # build deb package - needs python3-stdeb\n    poetry run python setup.py --command-packages=stdeb.command bdist_deb\n\n",
    "bugtrack_url": null,
    "license": "BSD-3-Clause",
    "summary": "Lvm Tan Clu Wrapper",
    "version": "0.3.3",
    "project_urls": {
        "Documentation": "https://sdss-lvmtan.readthedocs.org",
        "Homepage": "https://github.com/sdss/lvmtan",
        "Repository": "https://github.com/sdss/lvmtan"
    },
    "split_keywords": [
        "astronomy",
        "software"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b87ad420e98107a1e2960a158e0ce3519bed935d7ca9eee2e86ffd528588d026",
                "md5": "ccc44f81096110061c0a5079da510e44",
                "sha256": "2730c4094c272f7dc5975800fe6f6e6a705a023a03e5332de063a63f20e31ae1"
            },
            "downloads": -1,
            "filename": "sdss_lvmtan-0.3.3-cp310-cp310-macosx_12_0_x86_64.whl",
            "has_sig": false,
            "md5_digest": "ccc44f81096110061c0a5079da510e44",
            "packagetype": "bdist_wheel",
            "python_version": "cp310",
            "requires_python": ">=3.8,<4",
            "size": 86730,
            "upload_time": "2024-03-11T12:46:55",
            "upload_time_iso_8601": "2024-03-11T12:46:55.665989Z",
            "url": "https://files.pythonhosted.org/packages/b8/7a/d420e98107a1e2960a158e0ce3519bed935d7ca9eee2e86ffd528588d026/sdss_lvmtan-0.3.3-cp310-cp310-macosx_12_0_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "da8f1465c695a48b510148585a030bb5269d2667d23415cb10270c3bbba0f676",
                "md5": "00b3a7a23204cdc14800b45b3ed5909e",
                "sha256": "53b487586b950e307cc4833f7d5781749775b82e8b34470a8b63e66340c25288"
            },
            "downloads": -1,
            "filename": "sdss_lvmtan-0.3.3.tar.gz",
            "has_sig": false,
            "md5_digest": "00b3a7a23204cdc14800b45b3ed5909e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<4",
            "size": 37944,
            "upload_time": "2024-03-11T12:46:57",
            "upload_time_iso_8601": "2024-03-11T12:46:57.612697Z",
            "url": "https://files.pythonhosted.org/packages/da/8f/1465c695a48b510148585a030bb5269d2667d23415cb10270c3bbba0f676/sdss_lvmtan-0.3.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-11 12:46:57",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "sdss",
    "github_project": "lvmtan",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "sdss-lvmtan"
}
        
Elapsed time: 0.20036s