SOURCEFORGE » RALF

h1. RAdio Logicielle pour la Formation (RALF)

!>logo-ralf-240x148.png!

Welcome to the main wiki page of the _RAdio Logicielle pour la Formation_ (RALF) project. You will find here a complete list of available resources and their operating procedures (hardware booking, platform access...). Documentation is also provided in order to help users in building their SDR(Software Defined Radio) workbench. Do not hesitate to contribute !

For general information on the project, you can also visit our "website":http://ralf.isae.fr.

{{toc}}

h2. Hardware resources

The project includes two types of equipments: light hardware (available for loan) and heavy hardware (available at onsite, at Supaero campus).

* [[Mobile hardware inventory]]

* [[Platform inventory]] (coming in October, 2015)

h2. Getting started

* [[Using a RALF workstation]]

* [[Debian Wheezy 7 installation guidelines]]

* [[UHD and GNURadio installation from sources with PyBombs]]

* [[USRP1, B100 and B200 installation notes (USB)]]

* [[USRP N2x0 and X3x0 installation notes (Gigabit Ethernet)]]

* [[Running examples and getting started]]

h2. Using the forge

h3. Text formating in SourceForge

The forge uses a markup language called _Textile_ and characterized by simple and intuitive tags.

* Official "documentation":http://www.redmine.org/projects/redmine/wiki/RedmineTextFormatting with all bindings.

* "Documentation":http://projects.andriylesyuk.com/projects/wiking/wiki/Syntax on the Wiking text formating extension.

* The MathJax plugin allows to interpret LaTeX source code. For example @$\sum_i x_i$@ gives $\sum_i x_i$. More documentation "here":https://github.com/process91/redmine_latex_mathjax.

h3. Using Git repositories in SourceForge

Every project is provided with a Git repository which is accessible at the following URL(Uniform Resource Locator):

<pre>

https://votre_login@sourceforge.isae.fr/git/<project-id>

</pre>

where @<project-id>@ is the project identifier as it appears in the SourceForge's URL(Uniform Resource Locator).

* [[Initializing and synchronizing a Git repository]]

* [[Joining an existing Git repository]]

For further documentation, a tutorial on Git handling is provided "here":https://fr.atlassian.com/git/tutorials/setting-up-a-repository or "there":http://backlogtool.com/git-guide/en/intro/intro1_1.html. You can also refer to the official "documentation":http://git-scm.com/doc.

h2. Procedures and good practices

h3. Local managers

For each school participating to the project, at least one local manager has been nominated. They can create projects on the forge, borrow equipments, book the platform...

Local managers:

* Pascal Berthou (UPS);

* Daniela Dragomirescu (INSA);

* Laurent Franck (TELECOM Bretagne);

* Christophe Morlaas (ENAC);

* Damien Roque (ISAE);

* Nathalie Thomas (ENSEEIHT).

h3. Forge sub-projects creation and use

This forge allows per-project spaces providing various services such as ticket management, source versioning (Git), wiki, forums... Every RALF member is encouraged to centralize the documentation using this service. Local managers can create sub-projects under their respective branches (ENAC, ENSEEIHT, INSA, ISAE, UPS). If a you encounter an issue, please refer to the procedure available on [[Sourceforge:Submissions_on_sourceforgeisaefr|this page]]. See below for a list of recommendations.

* Authorized languages for your projects are English (preferred) and French (do not mix both).

* Use UTF-8 encoding for text files.

* Define and respect a naming convention for enclosed files (with no spaces, no capital letters, no accents...).

* Write precise tickets for small pieces of work.

* Try to adopt a clear structure in you Wiki.

* Do not include the following files in your source code repository: results from compilation process, temporary, huge binary files.

h3. Hardware loan request

Every local manager can make an loan request using the ticket manager. The procedure is the following.

# Check for the availability of the needed hardware: see the inventory above as well as the ticket manager (use custom report "current hardware loans").

# Write a new ticket asking for the resources with the following settings.

* A clear subject and description (type and number of equipments).

* A starting date and a end date.

* Tracker: request.

* Status: assigned.

* Assignee: Damien Roque

* Category: loan.

Once the hardware is returned, the ticket will be closed.

h3. Platform access request

Every local manager can make an booking request using the ticket manager. The procedure is the following.

# Check for the availability of the platform: see the ticket manager (use custom report "current platform reservations").

# Write a new ticket assigned asking for the resources with the following settings.

* A clear subject and description (precise the number of students and the requested resources).

* A starting date and a end date.

* Tracker: request.

* Status: assigned.

* Assignee: Damien Roque

* Category: platform.

Once the hardware is returned, the ticket will be closed.