omxware 0.1.5

Python wrapper for OMXWare REST services to access Data and Files.

=======
OMXWare
=======

.. image:: https://travis.ibm.com/GrandChallenge-Almaden/omxware-pypi.svg?token=zra2vLszsZmyB2CQTsas&branch=master
:target: https://travis.ibm.com/GrandChallenge-Almaden/omxware-pypi


.. image:: https://badge.fury.io/py/omxware.svg
:target: https://badge.fury.io/py/omxware
:alt: Latest Version

|

**Web Services**

`https://omxware.sl.cloud9.ibm.com:9420/swagger <https://omxware.sl.cloud9.ibm.com:9420/swagger>`_

---------------

**SDK Documentation:**

`https://pages.github.ibm.com/GrandChallenge-Almaden/omxware-pypi/ <https://pages.github.ibm.com/GrandChallenge-Almaden/omxware-pypi/>`_

---------------

**Getting Started**

`https://pages.github.ibm.com/GrandChallenge-Almaden/omxware-pypi/build/html/usage.html <https://pages.github.ibm.com/GrandChallenge-Almaden/omxware-pypi/build/html/usage.html>`_

---------------

**Help / Forums**

`http://omx-forums.sl.cloud9.ibm.com <http://omx-forums.sl.cloud9.ibm.com>`_

---------------

Citation
***************
* Please contact the `OMXWare Team via the Forums <http://omx-forums.sl.cloud9.ibm.com/t/how-do-i-cite-omxware-in-a-presentation-or-publication/133>`_ for updated citation information prior to publishing or presenting OMXWare content.

e.g: ``"OMXWare: Microbial Life at Scale" IBM Research, manuscript in preparation``

|

Use with Docker
***************


In an effort to make it easier to get started with OMXWare, we now have a docker image with ``python2`` and ``python3`` pre-installed.

* It comes with the latest ``omxware`` sdk pre-installed along with a bunch of python libs like ``matplotlib``, ``numpy`` and some others.

* This image also comes with a ``Jupyter`` server pre-installed.

---------------

.. code-block:: bash

docker run -d --name jupyter --restart always -p 8888:8888 -e JUPYTER_ENABLE_LAB=yes \
-v /mnt/storage/jupyter:/home/jovyan/work c0mpiler/jupyter start.sh jupyter lab --LabApp.token=‘omxware’

---------------

* Change the mount point ``/mnt/storage/jupyter`` to whatever you want on you host machine – so you can share files from your host with this docker image.

* This image also has some example Jupyter notebooks for you to look at and get started.

* Once you run the docker image – you can open up ``http://<host-name>:8888/lab?`` in your browser and the pwd is ``omxware``.

* The host-name is that of your host machine you run this docker image on. If you are running it on your laptop, the host-name is either ``localhost`` or ``0.0.0.0``





=======
History
=======

0.1.0 (2019-04-17)
------------------

* First release on PyPI.