Difference between revisions of "Software contribution"

Latest revision as of 21:38, 19 January 2020

If you are skilled in Python, Web Development (CSS/JS), or gnuradio we need your help! To find out how to help see each module below. You can also find us on our forum or on irc/matrix in #satnogs-dev

SatNOGS Client

Skills required: Python

The SatNOGS client is written in Python, targeting raspberry pi as the reference architecture. It interfaces with the following applications:

rotctld (Rotator control, part of hamlib)
rigctld (Rig frequency control, part of hamlib)
gr-satnogs (custom SatNOGS gnuradio scripts)

Architecture documentation: https://docs.satnogs.org/projects/satnogs-client/en/stable/architecture.html

Code repository: https://gitlab.com/librespacefoundation/satnogs/satnogs-client

Dev setup guide: SatNOGS_Client_Development#satnogs-client

Note that development happens on the "0" branch, with periodic merges to master for release; PRs should be submitted against the "0" branch.

SatNOGS Client image / setup script

Skills required: Linux administration, .deb packaging, Ansible

We provide a custom raspbian image for Raspberry Pi using pi-gen and a satnogs-setup script that configures the client via Ansible. In addition we package gr-satnogs as a .deb through GitLab CI. If you would like to help out check out our repositories below:

pi-gen repository: https://gitlab.com/librespacefoundation/satnogs/satnogs-pi-gen
gr-satnogs .deb repository: https://gitlab.com/librespacefoundation/satnogs/gr-satnogs-package
satnogs-setup ansible repository: https://gitlab.com/librespacefoundation/satnogs/satnogs-client-ansible

gr-satnogs

Skills required: gnuradio companion, C/C++, SDR

If you are skilled in writing custom gnuradio modules/blocks or piecing together gnuradio scripts in gnuradio-companion then gr-satnogs can use your help!

Code repository: https://gitlab.com/librespacefoundation/satnogs/gr-satnogs

Dev setup guide: SatNOGS_Client_Development#gr-satnogs_and_gr-satnogs-package

SatNOGS DB

Skills required: Python / Django / CSS

The SatNOGS DB is written in Django (a Python web framework).

Installation documentation: https://docs.satnogs.org/projects/satnogs-db/en/stable/installation.html

Contribute documentation: https://docs.satnogs.org/projects/satnogs-db/en/stable/

API documentation: https://docs.satnogs.org/projects/satnogs-db/en/stable/api.html

Code repository: https://gitlab.com/librespacefoundation/satnogs/satnogs-db

SatNOGS Network

Skills required: Python / Django / CSS / JS

The SatNOGS Network is written in Django (a Python web framework), and makes heavier use of javascript and d3.js for scheduling and visualizations.

Installation documentation: https://docs.satnogs.org/projects/satnogs-network/en/stable/installation.html

Contribute documentation: https://docs.satnogs.org/projects/satnogs-network/en/stable/

Code repository: https://gitlab.com/librespacefoundation/satnogs/satnogs-network

@@ Line 1: / Line 1: @@
-If you are skilled in Python, Web Development (CSS/JS), or gnuradio we need your help! To find out how to help see each module below. You can also find us on our [[forum|https://community.libre.space]] or on irc/matrix in #satnogs
+__NOTOC__
-__TOC__
+If you are skilled in Python, Web Development (CSS/JS), or gnuradio we need your help! To find out how to help see each module below. You can also find us on our [https://community.libre.space forum] or on irc/matrix in #satnogs-dev
-=== SatNOGS Client ===
+===SatNOGS Client===
+[[File:Python-powered-h-140x182.png|alt=python logo|left|frameless|130x130px]]
 '''Skills required: Python'''
-The SatNOGS client is written in Python, targeting raspberry pi 3 as the reference architecture. It interfaces with the following applications:
+The SatNOGS client is written in Python, targeting raspberry pi as the reference architecture. It interfaces with the following applications:
-* rotctld (Rotator control, part of hamlib)
+*rotctld (Rotator control, part of hamlib)
-* rigctld (Rig frequency control, part of hamlib)
+*rigctld (Rig frequency control, part of hamlib)
-* gr-satnogs (custom SatNOGS gnuradio scripts)
+*gr-satnogs (custom SatNOGS gnuradio scripts)
-Architecture documentation: https://docs.satnogs.org/en/stable/satnogs-client/doc/architecture.html
+Architecture documentation: https://docs.satnogs.org/projects/satnogs-client/en/stable/architecture.html
 Code repository: https://gitlab.com/librespacefoundation/satnogs/satnogs-client
-=== SatNOGS Client image / setup script ===
+Dev setup guide: [[SatNOGS_Client_Development#satnogs-client]]
+Note that development happens on the "0" branch, with periodic merges to master for release; PRs should be submitted against the "0" branch.
+<div></div>
+===SatNOGS Client image / setup script===
+[[File:Ansible logo.png|alt=ansible logo|left|frameless|123x123px]]
 '''Skills required: Linux administration, .deb packaging, Ansible'''
-We provide a custom raspbian image for Raspberry Pi 3 using ''pi-gen'' and a satnogs-setup script that configures the client via Ansible. In addition we package gr-satnogs as a .deb through GitLab CI. If you would like to help out check out our repositories below:
+We provide a custom raspbian image for Raspberry Pi using ''pi-gen'' and a satnogs-setup script that configures the client via Ansible. In addition we package gr-satnogs as a .deb through GitLab CI. If you would like to help out check out our repositories below:
-pi-gen repository: https://gitlab.com/librespacefoundation/satnogs/satnogs-pi-gen
-gr-satnogs .deb repository: https://gitlab.com/librespacefoundation/satnogs/gr-satnogs-package
-satnogs-setup ansible repository: https://gitlab.com/librespacefoundation/satnogs/satnogs-client-ansible
-=== gr-satnogs ===
+*pi-gen repository: https://gitlab.com/librespacefoundation/satnogs/satnogs-pi-gen
+*gr-satnogs .deb repository: https://gitlab.com/librespacefoundation/satnogs/gr-satnogs-package
+*satnogs-setup ansible repository: https://gitlab.com/librespacefoundation/satnogs/satnogs-client-ansible
+<div></div>
+===gr-satnogs===
+[[File:Gnuradio logo.png|alt=gnuradio logo|left|frameless|100x100px]]
 '''Skills required: gnuradio companion, C/C++, SDR'''
@@ Line 35: / Line 39: @@
 Code repository: https://gitlab.com/librespacefoundation/satnogs/gr-satnogs
-=== SatNOGS DB ===
+Dev setup guide: [[SatNOGS_Client_Development#gr-satnogs_and_gr-satnogs-package]]
+<div></div>
+===SatNOGS DB===
+[[File:Django logo.jpg|alt=django logo|left|frameless|100x100px]]
 '''Skills required: Python / Django / CSS'''
 The SatNOGS DB is written in Django (a Python web framework).
-Installation documentation: https://docs.satnogs.org/en/stable/satnogs-db/docs/installation.html
+Installation documentation: https://docs.satnogs.org/projects/satnogs-db/en/stable/installation.html
-Contribute documentation: https://docs.satnogs.org/en/stable/satnogs-db/docs/contribute.html
+Contribute documentation: https://docs.satnogs.org/projects/satnogs-db/en/stable/
-API documentation: https://docs.satnogs.org/en/stable/satnogs-db/docs/api.html
+API documentation: https://docs.satnogs.org/projects/satnogs-db/en/stable/api.html
 Code repository: https://gitlab.com/librespacefoundation/satnogs/satnogs-db
+<div></div>
-=== SatNOGS Network ===
+===SatNOGS Network===
+[[File:Django logo.jpg|alt=django logo|left|frameless|100x100px]]
 '''Skills required: Python / Django / CSS / JS'''
 The SatNOGS Network is written in Django (a Python web framework), and makes heavier use of javascript and d3.js for scheduling and visualizations.
-Installation documentation: https://docs.satnogs.org/en/stable/satnogs-network/docs/installation.html
+Installation documentation: https://docs.satnogs.org/projects/satnogs-network/en/stable/installation.html
-Contribute documentation: https://docs.satnogs.org/en/stable/satnogs-network/docs/contribute.html
+Contribute documentation: https://docs.satnogs.org/projects/satnogs-network/en/stable/
 Code repository: https://gitlab.com/librespacefoundation/satnogs/satnogs-network
+[[Category:Develop]]
+[[Category:Software]]