<commit_before>.. image:: https://badge.waffle.io/CSC-IT-Center-for-Science/pebbles.png?label=ready&title=Ready 
 :target: https://waffle.io/CSC-IT-Center-for-Science/pebbles
 :alt: 'Stories in Ready'
.. image:: https://travis-ci.org/CSC-IT-Center-for-Science/pebbles.svg
   :target: https://travis-ci.org/CSC-IT-Center-for-Science/pebbles/
   :alt: Build Status
.. image:: https://codeclimate.com/github/CSC-IT-Center-for-Science/pouta-blueprints/badges/gpa.svg
   :target: https://codeclimate.com/github/CSC-IT-Center-for-Science/pouta-blueprints
   :alt: Code Climate
.. image:: https://codeclimate.com/github/CSC-IT-Center-for-Science/pouta-blueprints/badges/coverage.svg
   :target: https://codeclimate.com/github/CSC-IT-Center-for-Science/pouta-blueprints
   :alt: Test Coverage

Pebbles
****************

**Pebbles** (formerly Pouta Blueprints) is a frontend to manage cloud
resources and lightweight user accounts. Currently supported resource types
are:

- `OpenStack driver`_,
  which can be used to launch instances on OpenStack cloud.
- `Docker driver`_,
  for running web notebook instances in Docker containers on a pool of virtual machines. 
- `Pouta Virtualcluster`_ ,
  which can be used to launch clusters on `cPouta <https://research.csc.fi/pouta-iaas-cloud>`_.

    
Additional resources can be added by implementing the driver interface. ToDo:
hyperlink to new docs.

Documentation
=============

The system comes with Sphinx RST documentation under doc/. Convention is to have
as much as possible as docstrings close to the code that implements. Generic
things like system descriptions may also be under doc/source. ::

        $ mkvirtualenv pb-doc
        (pb-doc) $ pip install -r requirements.txt
        (pb-doc) $ cd doc && make html<commit_msg>update readme to refer to online documentation<commit_after>.. image:: https://badge.waffle.io/CSC-IT-Center-for-Science/pebbles.png?label=ready&title=Ready 
 :target: https://waffle.io/CSC-IT-Center-for-Science/pebbles
 :alt: 'Stories in Ready'
.. image:: https://travis-ci.org/CSC-IT-Center-for-Science/pebbles.svg
   :target: https://travis-ci.org/CSC-IT-Center-for-Science/pebbles/
   :alt: Build Status
.. image:: https://codeclimate.com/github/CSC-IT-Center-for-Science/pouta-blueprints/badges/gpa.svg
   :target: https://codeclimate.com/github/CSC-IT-Center-for-Science/pouta-blueprints
   :alt: Code Climate
.. image:: https://codeclimate.com/github/CSC-IT-Center-for-Science/pouta-blueprints/badges/coverage.svg
   :target: https://codeclimate.com/github/CSC-IT-Center-for-Science/pouta-blueprints
   :alt: Test Coverage

Pebbles
****************

**Pebbles** (formerly Pouta Blueprints) is a frontend to manage cloud
resources and lightweight user accounts. Currently supported resource types
are:

- `OpenStack driver`_,
  which can be used to launch instances on OpenStack cloud.
- `Docker driver`_,
  for running web notebook instances in Docker containers on a pool of virtual machines. 
    
Additional resources can be added by implementing the driver interface. 

Documentation
=============

`Documentation hosted on GitHub
<http://csc-it-center-for-science.github.io/pebbles/>`_.

The documentation is generated from Sphinx RST documentation under doc/ and
inline in the code.. Convention is to have as much as possible as docstrings
close to the code that implements said functionality. Module level docstrings
can be used to give end-user readable generic description of system parts.
Things that aren't naturally tied to a code module or artefact can be created
under doc/source. 

Building the documentation can be one as follows ::

        $ mkvirtualenv pb-doc
        (pb-doc) $ pip install -r requirements.txt
        (pb-doc) $ cd doc && make html
{'fraction_non_alphanumeric': 0.12243264870632169, 'fraction_numerical': 0.0, 'mean_word_length': 4.006675567423231, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 17, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7092138', 'n_tokens_mistral': 1212, 'n_tokens_neox': 1154, 'n_words': 338}