Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 0 additions & 22 deletions docs/developers_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,27 +40,5 @@ You can then push your changes to your online repository on GitHub::
Once you think your changes are ready to be included in the main Neo repository,
open a pull request on GitHub (see https://help.github.com/articles/using-pull-requests).

Testing
-------

**WARNING**: Tests can be destructive and have to be run on a different server.
Use `expipe-debug.firebaseio.com` for testing.

A separate config file needs to be created if you want to run tests. The config
file needs to be placed in `~/.config/expipe/test-config.yaml` and must have
the key `allow_tests: true`. Here is an example:

.. code-block:: yaml

allow_tests: true
data_path: '/tmp/expipe-data'
firebase:
email: <needs to be changed>
password: <needs to be changed>
config:
apiKey: AIzaSyBnbsraKxrO8zv1qVZeAvJR4fEWzExQhOM
authDomain: expipe-debug.firebaseapp.com
databaseURL: https://expipe-debug.firebaseio.com
storageBucket: expipe-debug.appspot.com

.. _GitHub: http://github.com
23 changes: 2 additions & 21 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Create a new project if it does not exist with ``require_project``:
>>> project = expipe.require_project("test")

The default backend for Expipe uses the filesystem.
In this case, the above command will create a folder named `test` in your current
In this case, the above command will create a folder named `test` in your current
working directory.
Other backends will create a backend-specific project in its database.

Expand Down Expand Up @@ -101,7 +101,7 @@ To further retrieve and edit the values of a module, you can use `module.to_dict
From template to module
-----------------------

To upload a template you can write it in ``json`` or as a ``dict`` and use
To upload a template you can write it as a ``dict`` and use
``require_template``.

.. doctest::
Expand All @@ -113,10 +113,6 @@ To upload a template you can write it in ``json`` or as a ``dict`` and use
>>> expipe.require_template(template='hardware_daq',
... contents=daq_contents)

Contents can also be a ``.json`` file::

expipe.require_template(template='hardware_daq',
contents='daq_contents.json')

In order to use a template and add it as a module to an `action` use
``action.require_module``:
Expand All @@ -137,21 +133,6 @@ and values use ``to_dict``:
>>> print(daq_dict.values())
odict_values([{'definition': 'The number of input channels of the DAQ-device.', 'value': '64'}])

You may also view the module as ``.json`` by using the command ``to_json``:

.. doctest::

>>> daq.to_json()
Saving module "hardware_daq" to "hardware_daq.json"

To furter change its values and upload them to Firebase:

.. doctest::

>>> daq_dict['gain'] = {'value': 20}
>>> daq = action.require_module(name='hardware_daq', contents=daq_dict,
... overwrite=True)

Messages
--------

Expand Down
6 changes: 3 additions & 3 deletions docs/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ To ease this organization we introduce a tool for the experiment pipeline named
* support high throughput data analysis.
* support multiple types of large-scale data sets.

To this end we use the flexible `Firebase <https://firebase.google.com/>`_
NoSQL type database to store metadata. This way of storing metadata consist of
assigning key value pairs in a `json <http://www.json.org/>`_ type format.
To this end we use the flexible filesystem as a
NoSQL type database to store data and metadata. This way of storing metadata consist of
assigning key value pairs.

During an experiment metadata can be automatically added by user specific
`templates`. Templates are prefilled key value pairs describing all aspects
Expand Down
2 changes: 1 addition & 1 deletion expipe/backends/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
from .firebase import FirebaseBackend

Loading