sciunit2


Namesciunit2 JSON
Version 0.4.post115.dev43584757 PyPI version JSON
download
home_pagehttps://sciunit.run/
SummarySciunit command line
upload_time2024-03-25 23:28:54
maintainerZhihao Yuan
docs_urlNone
authorZhihao Yuan, Tanu Malik
requires_pythonNone
licenseBSD
keywords sciunit reproducibility container versioning
VCS
bugtrack_url
requirements setuptools tzlocal utcdatetime zipfile2 scandir retry humanfriendly configobj hs_restclient contextlib2 tqdm backports.tempfile
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. image:: https://github.com/depaul-dice/sciunit/actions/workflows/ubuntu.yaml/badge.svg
    :target: https://github.com/depaul-dice/sciunit/actions/workflows/ubuntu.yaml
.. image:: https://img.shields.io/pypi/v/sciunit2
   :alt: PyPI
   :target: https://pypi.org/project/sciunit2/

Sciunit
----------

**The most updated instructions on installing Sciunit can be found at:**
**https://sciunit.run/install**

**sciunit** is a command-line tool that answers the call for a
reusable research object that containerizes and stores applications
simply and efficiently, facilitates sharing and collaboration, and
eases the task of executing, understanding, and building on shared
work.

Installing
=============

This section introduces the binary distributions of sciunit.

Requires: pip>=8.1.1, glibc>=2.17, python2.7 with headers and compiler

Platform: amd64-pc-linux-gnu

Ensure that *~/.local/bin* is in your ``PATH`` environment variable,
and then, run

::

    pip2 install --user sciunit2

Add ``--upgrade`` to the command line arguments to upgrade an existing
sciunit installation.

*[ Note*
Attempt to install sciunit with "pip install sciunit" will get you something
else; our PyPI project is registered as "sciunit2".
*--end note ]*

Verify the installation with

::

    sciunit --version

In the following per-distro instructions, if you see a command-line
in the form of

::

    export PATH=~/.local/bin:$PATH

, it merely means that you will need the aforementioned binary path
in ``PATH`` before proceeding; normally you should adjust it according
to your login shell and write it to a shell configuration such as
*~/.profile*.

Ubuntu 16.04
~~~~~~~~~~~~~
::

    sudo apt update
    sudo apt install python-dev python-pip
    pip2 install --user sciunit2

Ubuntu 14.04
~~~~~~~~~~~~~
::

    sudo apt update
    sudo apt install python-dev python-pip
    pip2 install --user -U pip
    export PATH=~/.local/bin:$PATH
    pip2 install --user sciunit2


Arch Linux
~~~~~~~~~~~~~
::

    sudo pacman -S python2-pip
    export PATH=~/.local/bin:$PATH
    pip2 install --user sciunit2

Fedora 26
~~~~~~~~~~~~~
::

    sudo dnf install python2-pip python2-devel gcc redhat-rpm-config
    pip2 install --user sciunit2

CentOS 7
~~~~~~~~~~~~~
::

    sudo yum install -y epel-release
    sudo yum install python2-pip python-devel gcc
    pip2 install --user sciunit2

RHEL 7
~~~~~~~~~~~~~
::

    sudo yum install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm
    sudo yum install python2-pip python-devel gcc
    pip2 install --user sciunit2

Debian 9
~~~~~~~~~~~~~
::

    sudo apt update
    sudo apt install python-dev python-pip
    export PATH=~/.local/bin:$PATH
    pip2 install --user sciunit2

Debian 8
~~~~~~~~~~~~~
::

    sudo apt update
    sudo apt install python-dev python-pip
    pip2 install --user -U pip
    export PATH=~/.local/bin:$PATH
    pip2 install --user sciunit2

OpenSUSE 42
~~~~~~~~~~~~~

Note that OpenSUSE defaults user-binary path to *~/bin* rather than
*~/.local/bin*, so you may want to symlink one to the other.

::

    sudo zypper install python-pip python-devel gcc
    pip2 install --user -U pip
    export PATH=~/.local/bin:$PATH
    pip2 install --user sciunit2

Build from Source
~~~~~~~~~~~~~~~~~~~

Instructions for `custom build
<https://bitbucket.org/geotrust/sciunit2/src/master/docs/build.md>`_
of sciunit2 is available in our Bitbucket project repository.  You may
want to check it out if you are running on a system that is not
supported by the binary distribution.

Post-install
=============

Execute

::

    sciunit post-install

as a normal user to add command-line completion support for
**sciunit** to your login shell.  When running this or any other
sciunit command, if your environment is not listed in the
`Installing`_ section, or you missed some prerequisites before
issuing ``pip``, you may observe the following error:

::

    ImportError: No module named _bsddb

Fortunately, there are more than one ways to fulfill this dependency.
Try to find and install a package often named "python-bsddb" or
"python-bsddb3" with your system package manager.  In Anaconda,
you will need a port called "bsddb."

To make the command-line completion work, if you are a **bash** users,
make sure that you have the "bash-completion" package installed on your
system.  If you are a **tcsh** user, make sure that you have
``source ~/.complete`` in *~/.cshrc* or *~/.tcshrc* as suggested by
the stock `completion script
<https://github.com/tcsh-org/tcsh/blob/master/complete.tcsh>`_.

Using
===========

Checkout our `tutorial <https://sciunit.run/docs/>`_ and manpage.
The manpage is available as

::

    man sciunit

after a successful installation.

Sciunit acknowledges support from the National Science Foundation,
Bloomberg Foundation, and DePaul University.



            

Raw data

            {
    "_id": null,
    "home_page": "https://sciunit.run/",
    "name": "sciunit2",
    "maintainer": "Zhihao Yuan",
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": "lichray@gmail.com",
    "keywords": "sciunit, reproducibility, container, versioning",
    "author": "Zhihao Yuan, Tanu Malik",
    "author_email": "pr@sciunit.run",
    "download_url": "https://files.pythonhosted.org/packages/f3/78/5576790dbd5eed7d34505ae89b958473dc64e6f79d23ccbb4b8fab61586c/sciunit2-0.4.post115.dev43584757.tar.gz",
    "platform": null,
    "description": ".. image:: https://github.com/depaul-dice/sciunit/actions/workflows/ubuntu.yaml/badge.svg\n    :target: https://github.com/depaul-dice/sciunit/actions/workflows/ubuntu.yaml\n.. image:: https://img.shields.io/pypi/v/sciunit2\n   :alt: PyPI\n   :target: https://pypi.org/project/sciunit2/\n\nSciunit\n----------\n\n**The most updated instructions on installing Sciunit can be found at:**\n**https://sciunit.run/install**\n\n**sciunit** is a command-line tool that answers the call for a\nreusable research object that containerizes and stores applications\nsimply and efficiently, facilitates sharing and collaboration, and\neases the task of executing, understanding, and building on shared\nwork.\n\nInstalling\n=============\n\nThis section introduces the binary distributions of sciunit.\n\nRequires: pip>=8.1.1, glibc>=2.17, python2.7 with headers and compiler\n\nPlatform: amd64-pc-linux-gnu\n\nEnsure that *~/.local/bin* is in your ``PATH`` environment variable,\nand then, run\n\n::\n\n    pip2 install --user sciunit2\n\nAdd ``--upgrade`` to the command line arguments to upgrade an existing\nsciunit installation.\n\n*[ Note*\nAttempt to install sciunit with \"pip install sciunit\" will get you something\nelse; our PyPI project is registered as \"sciunit2\".\n*--end note ]*\n\nVerify the installation with\n\n::\n\n    sciunit --version\n\nIn the following per-distro instructions, if you see a command-line\nin the form of\n\n::\n\n    export PATH=~/.local/bin:$PATH\n\n, it merely means that you will need the aforementioned binary path\nin ``PATH`` before proceeding; normally you should adjust it according\nto your login shell and write it to a shell configuration such as\n*~/.profile*.\n\nUbuntu 16.04\n~~~~~~~~~~~~~\n::\n\n    sudo apt update\n    sudo apt install python-dev python-pip\n    pip2 install --user sciunit2\n\nUbuntu 14.04\n~~~~~~~~~~~~~\n::\n\n    sudo apt update\n    sudo apt install python-dev python-pip\n    pip2 install --user -U pip\n    export PATH=~/.local/bin:$PATH\n    pip2 install --user sciunit2\n\n\nArch Linux\n~~~~~~~~~~~~~\n::\n\n    sudo pacman -S python2-pip\n    export PATH=~/.local/bin:$PATH\n    pip2 install --user sciunit2\n\nFedora 26\n~~~~~~~~~~~~~\n::\n\n    sudo dnf install python2-pip python2-devel gcc redhat-rpm-config\n    pip2 install --user sciunit2\n\nCentOS 7\n~~~~~~~~~~~~~\n::\n\n    sudo yum install -y epel-release\n    sudo yum install python2-pip python-devel gcc\n    pip2 install --user sciunit2\n\nRHEL 7\n~~~~~~~~~~~~~\n::\n\n    sudo yum install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm\n    sudo yum install python2-pip python-devel gcc\n    pip2 install --user sciunit2\n\nDebian 9\n~~~~~~~~~~~~~\n::\n\n    sudo apt update\n    sudo apt install python-dev python-pip\n    export PATH=~/.local/bin:$PATH\n    pip2 install --user sciunit2\n\nDebian 8\n~~~~~~~~~~~~~\n::\n\n    sudo apt update\n    sudo apt install python-dev python-pip\n    pip2 install --user -U pip\n    export PATH=~/.local/bin:$PATH\n    pip2 install --user sciunit2\n\nOpenSUSE 42\n~~~~~~~~~~~~~\n\nNote that OpenSUSE defaults user-binary path to *~/bin* rather than\n*~/.local/bin*, so you may want to symlink one to the other.\n\n::\n\n    sudo zypper install python-pip python-devel gcc\n    pip2 install --user -U pip\n    export PATH=~/.local/bin:$PATH\n    pip2 install --user sciunit2\n\nBuild from Source\n~~~~~~~~~~~~~~~~~~~\n\nInstructions for `custom build\n<https://bitbucket.org/geotrust/sciunit2/src/master/docs/build.md>`_\nof sciunit2 is available in our Bitbucket project repository.  You may\nwant to check it out if you are running on a system that is not\nsupported by the binary distribution.\n\nPost-install\n=============\n\nExecute\n\n::\n\n    sciunit post-install\n\nas a normal user to add command-line completion support for\n**sciunit** to your login shell.  When running this or any other\nsciunit command, if your environment is not listed in the\n`Installing`_ section, or you missed some prerequisites before\nissuing ``pip``, you may observe the following error:\n\n::\n\n    ImportError: No module named _bsddb\n\nFortunately, there are more than one ways to fulfill this dependency.\nTry to find and install a package often named \"python-bsddb\" or\n\"python-bsddb3\" with your system package manager.  In Anaconda,\nyou will need a port called \"bsddb.\"\n\nTo make the command-line completion work, if you are a **bash** users,\nmake sure that you have the \"bash-completion\" package installed on your\nsystem.  If you are a **tcsh** user, make sure that you have\n``source ~/.complete`` in *~/.cshrc* or *~/.tcshrc* as suggested by\nthe stock `completion script\n<https://github.com/tcsh-org/tcsh/blob/master/complete.tcsh>`_.\n\nUsing\n===========\n\nCheckout our `tutorial <https://sciunit.run/docs/>`_ and manpage.\nThe manpage is available as\n\n::\n\n    man sciunit\n\nafter a successful installation.\n\nSciunit acknowledges support from the National Science Foundation,\nBloomberg Foundation, and DePaul University.\n\n\n",
    "bugtrack_url": null,
    "license": "BSD",
    "summary": "Sciunit command line",
    "version": "0.4.post115.dev43584757",
    "project_urls": {
        "Documentation": "https://sciunit.run/docs/",
        "Homepage": "https://sciunit.run/",
        "Source": "https://github.com/depaul-dice/sciunit"
    },
    "split_keywords": [
        "sciunit",
        " reproducibility",
        " container",
        " versioning"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f607d5d85a6d6519dce79e20c3a7d63d2b438283979016576233b4e6ca62cf45",
                "md5": "b855da78fbec3cd448883ac2c8dfdda8",
                "sha256": "f50700c3c0e62575f4e6343f229e41700f2c47f0ef2b2c3e27f52400e46b2883"
            },
            "downloads": -1,
            "filename": "sciunit2-0.4.post115.dev43584757-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b855da78fbec3cd448883ac2c8dfdda8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 840566,
            "upload_time": "2024-03-25T23:28:51",
            "upload_time_iso_8601": "2024-03-25T23:28:51.828953Z",
            "url": "https://files.pythonhosted.org/packages/f6/07/d5d85a6d6519dce79e20c3a7d63d2b438283979016576233b4e6ca62cf45/sciunit2-0.4.post115.dev43584757-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f3785576790dbd5eed7d34505ae89b958473dc64e6f79d23ccbb4b8fab61586c",
                "md5": "532fb10e11f5554163a8c7a7359f4f92",
                "sha256": "8c084c7269bec3ef6e524da8c82dabcb980487b78d5a0575d1370871a7760b47"
            },
            "downloads": -1,
            "filename": "sciunit2-0.4.post115.dev43584757.tar.gz",
            "has_sig": false,
            "md5_digest": "532fb10e11f5554163a8c7a7359f4f92",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 887907,
            "upload_time": "2024-03-25T23:28:54",
            "upload_time_iso_8601": "2024-03-25T23:28:54.630935Z",
            "url": "https://files.pythonhosted.org/packages/f3/78/5576790dbd5eed7d34505ae89b958473dc64e6f79d23ccbb4b8fab61586c/sciunit2-0.4.post115.dev43584757.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-25 23:28:54",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "depaul-dice",
    "github_project": "sciunit",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "setuptools",
            "specs": []
        },
        {
            "name": "tzlocal",
            "specs": []
        },
        {
            "name": "utcdatetime",
            "specs": []
        },
        {
            "name": "zipfile2",
            "specs": []
        },
        {
            "name": "scandir",
            "specs": []
        },
        {
            "name": "retry",
            "specs": []
        },
        {
            "name": "humanfriendly",
            "specs": []
        },
        {
            "name": "configobj",
            "specs": []
        },
        {
            "name": "hs_restclient",
            "specs": []
        },
        {
            "name": "contextlib2",
            "specs": []
        },
        {
            "name": "tqdm",
            "specs": [
                [
                    ">=",
                    "4.17.1"
                ]
            ]
        },
        {
            "name": "backports.tempfile",
            "specs": []
        }
    ],
    "tox": true,
    "lcname": "sciunit2"
}
        
Elapsed time: 0.36368s