Commit 5761e6b7 authored by Samuel GAIST's avatar Samuel GAIST Committed by Flavio TARSETTI

[doc][libraries] Remove edition part

parent bf2ed390
......@@ -31,7 +31,8 @@ Libraries
functions. Instead of re-implementing every function from scratch, you can
reuse functions already implemented by other users and published in the form of
|project| libraries. Similarly, you can create and publish your own libraries
of functions that you consider may be useful to other users. For more information see the "Libraries" section of "Getting Started with BEAT" in `BEAT documentation`_.
of functions that you consider may be useful to other users. For more information see
the "Libraries" section of "Getting Started with BEAT" in `BEAT documentation`_.
Usage of libraries in encouraged in the |project| platform. Besides saving you
time and effort, this also promotes reproducibility in research.
......@@ -45,61 +46,15 @@ drop-down list. You should see a page similar to that shown below:
This page shows you all the libraries you have access to, on the platform. You
can use the Search-Box and the Privacy filters to limit your search to your
specific requirements. The page provides a ``New`` button to create a new
library. Note two items to the right of each library displayed on the page:
* a black circle showing how many experiments currently refer to this library,
and,
* a ``fork`` symbol that allows you to fork a new copy of the existing
library.
New libraries can be created either from scratch, or by editing the code from
existing libraries. Functions from libraries already used in at least one
experiment cannot be edited. However, the library may be forked, to create a
new version that can be edited. The |project| platform provides a `Library
Editor`_, to help with the creation of new libraries. There are several ways
of starting the library editor:
* click on the ``New`` button, to start creating a new library from scratch,
* click on the ``fork`` icon next to an existing library to create a new,
editable version of an existing library, or,
* click on the ``New Version`` button to start editing a new version of an
existing library.
.. _library editor:
Library Editor
--------------
When you start the ``Library Editor`` you will see a page similar to the
following:
.. image:: img/SS_libraries_editor.*
To create a library you will need to provide the following information:
* Name: enter the desired library-name in the text-box ``Name:``.
* Source code: add your (Python) code implementing the functions comprising
your library in the ``Source code:`` text-box.
Of course, functions implemented in a new library may also call functions from
other shared libraries in the |project| platform. You can indicate the
dependencies on other libraries via the ``External library usage`` section.
To save your work, click on the green ``Save`` button (in the top-right region
of the page). After you have saved your library, you will be able to use
functions from this library in your Algorithms code, and you will also be able
to share your library with other users.
specific requirements.
Sharing a library
-----------------
Like any other object in the |project| platform, you may also share your
library your library with other users. To do this, click on the green arrow in
the top right region on the page showing the library you want to share. (See
library with other users. To do this, click on the green arrow in the top right region
on the page showing the library you want to share. (See
image below.)
.. image:: img/SS_libraries_share0.*
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment