Metadata-Version: 1.1
Name: jupyter-o2
Version: 0.2.8
Summary: Run Jupyter on Orchestra 2
Home-page: https://github.com/aaronkollasch/jupyter-o2
Author: Aaron Kollasch
Author-email: awkollasch@gmail.com
License: MIT
Description: ===========
        Jupyter-O2
        ===========
        
        Jupyter-O2 is a command-line tool that automatically runs Jupyter on
        Orchestra 2, an HPC cluster managed by the HMS Resesarch Computing group.
        
        Installation
        ------------------------------
        First, follow the `O2 wiki's procedure <https://wiki.rc.hms.harvard.edu/display/O2/Jupyter+on+O2>`_
        to set up Jupyter for your account on O2.
        
        Next, install Jupyter-O2.
        
        .. code-block:: console
        
            pip install jupyter-o2
        
        Then, generate the config file.
        
        .. code-block:: console
        
            jupyter-o2 --generate-config
        
        Follow the printed path to ``jupyter-o2.cfg`` and edit according to its instructions, particularly the
        ``DEFAULT_USER``, ``MODULE_LOAD_CALL``, and ``SOURCE_JUPYTER_CALL`` fields.
        
        For more info on setting up Jupyter and troubleshooting Jupyter-O2, see the `jupyter-o2 tips`_.
        
        .. _jupyter-o2 tips: https://github.com/aaronkollasch/jupyter-o2/blob/master/jupyter_o2_tips.rst
        
        Usage
        ------------------------------
        .. code-block:: console
        
            jupyter-o2 [subcommand]
        
        Examples: ``jupyter-o2 notebook`` or ``jupyter-o2 lab``
        (try `JupyterLab <https://github.com/jupyterlab/jupyterlab>`__!)
        
        If Jupyter is installed on your machine, Jupyter-O2 can also be run as a Jupyter subcommand:
        
        .. code-block:: console
        
            jupyter o2 lab
        
        For info on the Jupyter-O2 command-line options, use ``jupyter-o2 --help``.
        
        Requirements and compatibility
        ------------------------------
        * python 2.7 or 3.6
        * pexpect.pxssh
        * POSIX: Jupyter-O2 has been tested on MacOS and Linux, while on Windows it should
          require Cygwin and Cygwin's version of Python.
        * pinentry (suggested)
        
        
Keywords: jupyter,remote,ssh,slurm,pexpect,orchestra,o2
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Science/Research
Classifier: Environment :: Console
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
