Difference between revisions of "Software contribution"

From SatNOGS
m
(Final batch of link fixing)
 
(2 intermediate revisions by the same user not shown)
Line 13: Line 13:
 
*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
 
Code repository: https://gitlab.com/librespacefoundation/satnogs/satnogs-client
Line 47: Line 47:
 
The SatNOGS DB is written in Django (a Python web framework).
 
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
 
Code repository: https://gitlab.com/librespacefoundation/satnogs/satnogs-db
Line 61: Line 61:
 
The SatNOGS Network is written in Django (a Python web framework), and makes heavier use of javascript and d3.js for scheduling and visualizations.
 
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
 
Code repository: https://gitlab.com/librespacefoundation/satnogs/satnogs-network
 
[[Category:Development]]
 
[[Category:Development]]

Latest revision as of 15:24, 4 November 2019


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

python logo

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

ansible logo

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:

gr-satnogs

gnuradio logo

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

django logo

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

django logo

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