caracal-destruct


Namecaracal-destruct JSON
Version 0.1.1 PyPI version JSON
download
home_pagehttps://github.com/caracal-pipeline/adestruction
SummaryBatch runners for CARACal
upload_time2024-02-27 10:25:06
maintainer
docs_urlNone
authorsphemakh
requires_python>=3.8,<4.0
licenseMIT
keywords astronomy slurm pipelines
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ============
adestruction
============

A Destruction of CARACals: Batch runners for CARACal

==============
Installation
==============
Installation from source_,
working directory where source is checked out

.. code-block:: bash
  
    pip install .

This package is available on *PYPI*, allowing

.. code-block:: bash
  
    pip install caracal-destruct

=====
Usage
=====

.. code-block:: bash

    caracal-destruct --help

.. code-block:: bash

    Usage: caracal-destruct [OPTIONS] CONFIG_FILE

    A destruction of CARACals: Batch runners for CARACal

    CONFIG_FILE: CARACal configuration file

  Options:
    -bc, --batch-config FILE  YAML file with batch configuration. Generated
                              automatically if unspecified.  [required]
    -nb, --nband INTEGER      Number of frequency bands to split data into
    -b, --bands TEXT          CASA-style comma separated bands (or spws) to
                              parallize the pipeline over. Overide -nb/--nband.
                              Example, '0:0~1023,0:1024~2048'
    -s, --skip TEXT           Skip the listed steps. Specify as a comma
                              separated list of integers (starting from zero) or
                              ms names/paths.
    --help                    Show this message and exit.

=======
License
=======

This project is licensed under the GNU General Public License v3.0 - see license_ for details.

=============
Contribute
=============

Contributions are always welcome! Please ensure that you adhere to our coding
standards pep8_.

.. _license: https://github.com/caracal-pipeline/adestruction/blob/main/LICENSE
.. _pep8: https://www.python.org/dev/peps/pep-0008
.. _source: https://github.com/caracal-pipeline/adestruction


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/caracal-pipeline/adestruction",
    "name": "caracal-destruct",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<4.0",
    "maintainer_email": "",
    "keywords": "Astronomy,Slurm,Pipelines",
    "author": "sphemakh",
    "author_email": "sphemakh@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/61/03/ff73894dc3df3e6ab6842282d664e14ee22b6fe73ea2cf1e2a0313896ea3/caracal_destruct-0.1.1.tar.gz",
    "platform": null,
    "description": "============\nadestruction\n============\n\nA Destruction of CARACals: Batch runners for CARACal\n\n==============\nInstallation\n==============\nInstallation from source_,\nworking directory where source is checked out\n\n.. code-block:: bash\n  \n    pip install .\n\nThis package is available on *PYPI*, allowing\n\n.. code-block:: bash\n  \n    pip install caracal-destruct\n\n=====\nUsage\n=====\n\n.. code-block:: bash\n\n    caracal-destruct --help\n\n.. code-block:: bash\n\n    Usage: caracal-destruct [OPTIONS] CONFIG_FILE\n\n    A destruction of CARACals: Batch runners for CARACal\n\n    CONFIG_FILE: CARACal configuration file\n\n  Options:\n    -bc, --batch-config FILE  YAML file with batch configuration. Generated\n                              automatically if unspecified.  [required]\n    -nb, --nband INTEGER      Number of frequency bands to split data into\n    -b, --bands TEXT          CASA-style comma separated bands (or spws) to\n                              parallize the pipeline over. Overide -nb/--nband.\n                              Example, '0:0~1023,0:1024~2048'\n    -s, --skip TEXT           Skip the listed steps. Specify as a comma\n                              separated list of integers (starting from zero) or\n                              ms names/paths.\n    --help                    Show this message and exit.\n\n=======\nLicense\n=======\n\nThis project is licensed under the GNU General Public License v3.0 - see license_ for details.\n\n=============\nContribute\n=============\n\nContributions are always welcome! Please ensure that you adhere to our coding\nstandards pep8_.\n\n.. _license: https://github.com/caracal-pipeline/adestruction/blob/main/LICENSE\n.. _pep8: https://www.python.org/dev/peps/pep-0008\n.. _source: https://github.com/caracal-pipeline/adestruction\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Batch runners for CARACal",
    "version": "0.1.1",
    "project_urls": {
        "Homepage": "https://github.com/caracal-pipeline/adestruction",
        "Repository": "https://github.com/caracal-pipeline/adestruction"
    },
    "split_keywords": [
        "astronomy",
        "slurm",
        "pipelines"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5c96bccb32f05016c0573d22a4b808bdd400e8def8ed1615eff5a24c68af6c64",
                "md5": "7dbaa34ab13bdcea057075ef91868992",
                "sha256": "c762b5b4459406737b89058f7dee43038d921b473268bf0e378ffc9ef2a21ece"
            },
            "downloads": -1,
            "filename": "caracal_destruct-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7dbaa34ab13bdcea057075ef91868992",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<4.0",
            "size": 8588,
            "upload_time": "2024-02-27T10:25:04",
            "upload_time_iso_8601": "2024-02-27T10:25:04.911331Z",
            "url": "https://files.pythonhosted.org/packages/5c/96/bccb32f05016c0573d22a4b808bdd400e8def8ed1615eff5a24c68af6c64/caracal_destruct-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6103ff73894dc3df3e6ab6842282d664e14ee22b6fe73ea2cf1e2a0313896ea3",
                "md5": "181168d285051c6f21d9471d7bebfc57",
                "sha256": "8abead25145c96ef92b412368c77337cca9cb67fe1aef65912f7245b36bd56fb"
            },
            "downloads": -1,
            "filename": "caracal_destruct-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "181168d285051c6f21d9471d7bebfc57",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<4.0",
            "size": 6503,
            "upload_time": "2024-02-27T10:25:06",
            "upload_time_iso_8601": "2024-02-27T10:25:06.427489Z",
            "url": "https://files.pythonhosted.org/packages/61/03/ff73894dc3df3e6ab6842282d664e14ee22b6fe73ea2cf1e2a0313896ea3/caracal_destruct-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-27 10:25:06",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "caracal-pipeline",
    "github_project": "adestruction",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "caracal-destruct"
}
        
Elapsed time: 3.03726s