Difference between revisions of "SatNOGS DB"

From SatNOGS Wiki
(Docker Installation: Updating documentation links to point to pages that exist.)
(Introduction)
 
(10 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
  
[https://db.satnogs.org/ SatNOGS DB] is an effort to create a holistic, unified, global transmitter database for all satellite transmitters. You can export the data or even connect your application using our API. It's part of the SatNOGS project.
+
==Introduction==
 +
 
 +
[https://db.satnogs.org/ SatNOGS DB] is an effort to create a holistic, unified, global transmitter database for all satellite information. You can export the data or even connect your application using our API. It's part of the SatNOGS project.
 +
[[File:SatNOGS DB front page.png|alt=|center|800x800px]]
 +
<br />
  
 
==Data==
 
==Data==
Line 14: Line 18:
 
#Navigate to https://db.satnogs.org/admin (if you are seeing a login screen, you are either not logged in to db.satnogs.org, or don't have moderator permissions)
 
#Navigate to https://db.satnogs.org/admin (if you are seeing a login screen, you are either not logged in to db.satnogs.org, or don't have moderator permissions)
 
#Click on Base::Satellite [https://db.satnogs.org/admin/base/satellite/add/ Add button]
 
#Click on Base::Satellite [https://db.satnogs.org/admin/base/satellite/add/ Add button]
#Complete the information to the best of your knowledge. Norad ID and Name are mandatory. Add multiple names on the "Names" field.
+
#Complete the information to the best of your knowledge. NORAD ID and Name are mandatory. Add multiple names on the "Names" field.
 
#Click Save and you are done!
 
#Click Save and you are done!
 
#You can now move on to the next steps: suggesting and approving transmitters for this satellite.
 
#You can now move on to the next steps: suggesting and approving transmitters for this satellite.
Line 21: Line 25:
  
 
===Suggesting transmitters===
 
===Suggesting transmitters===
Detailed instructions on suggesting transmitters can be found [http://docs.satnogs.org/db/contribute.html here].
+
[[File:Create new transmitter.png|thumb|Menu item to add new transmitter suggestion (for logged in users)]]
 +
[[File:Transmitter suggestion.png|alt=|thumb|New transmitter suggestion (any logged in user can do it!)]]
 +
We rely on crowd-sourced information to keep our transmitter details up to date. Anyone with a SatNOGS login can submit transmitter details. Moderators are notified and approve submissions frequently.
 +
 
 +
Navigate to the satellite you want to edit or suggest a new transmitter and click on the Edit menu while logged-in.<br />
 +
 
 +
*Description: This is the name that will appear for this transmitter across DB, Network, and API users. Please use the following notations
 +
**Band, for instance VHF,  or for a transceiver, MODE U/V
 +
**Baud (if applicable), in the format 9k6 for 9600
 +
**Mode, for instance FSK
 +
**Rough type description, ie TLM for "telemetry", or "FM Transponder" for repeater
 +
**Examples
 +
***UHF 9k6 FSK TLM
 +
***MODE U/V FM Transceiver
 +
***VHF CW TLM
 +
*Type
 +
**Transmitter: one-way downlink (telemetry)
 +
**Transceiver: repeats an uplinked signal intact
 +
**Transponder: interacts with an uplinked signal or downlinks after signal modification
 +
*Status
 +
**Active: alive and well
 +
**Inactive: not functional or powered down
 +
**Invalid: this is a legacy or erroneous transmitter information that should be hidden from UI
 +
*Downlink Freq: Published frequency, in Hz
 +
*Downlink Drifted: Observed frequency, or what frequency should be used to properly tune (with doppler correction). In most cases this should be the same as the Downlink frequency. This field '''must be entered''' even if there is no drift.
 +
*Downlink Mode: The modulation mode for this transmitter
 +
*Baud rate: the baud rate, if applicable. If this is a CW beacon, use WPM
 +
*Citation URL: a URL to link to in providing the details for your suggestion. Include observations from SatNOGS Network and/or frequency coordination documentation.
 +
*Service: The ITU service that the transmitter can be categorized.
  
 
===Approving transmitters===
 
===Approving transmitters===
 +
[[File:Review transmitter suggestion.png|thumb|Review transmitter suggestion (for moderators only)]]
 
If you are a moderator you can approved suggestions for transmitters. For that follow the instructions:
 
If you are a moderator you can approved suggestions for transmitters. For that follow the instructions:
  
 
#Log in to db.satnogs.org
 
#Log in to db.satnogs.org
#Navigate to https://db.satnogs.org/admin (if you are seeing a login screen, you are either not logged in to db.satnogs.org, or don't have moderator permissions)
+
#Navigate to the satellite page that has pending suggestions for transmitters
#Click on Base::Suggestions
+
#Review the suggestion
#Click on the suggestion you want to review and carefully check the data, especially the citation URL
+
#Decide to accept or reject it by clicking on the transmitter menu top right.
#When you are ready to approve or delete the suggestion, go back to the [https://db.satnogs.org/admin/base/suggestion/ full list of suggestions]
 
#Select the suggestions you want to act upon and from the drop down above either approve them or reject them
 
#You are done!
 
  
 
Note:  this process may change in the future; see [https://gitlab.com/librespacefoundation/satnogs/satnogs-db/issues?milestone_title=Improved+User+Experience the Gitlab issues list] for details.
 
Note:  this process may change in the future; see [https://gitlab.com/librespacefoundation/satnogs/satnogs-db/issues?milestone_title=Improved+User+Experience the Gitlab issues list] for details.
Line 41: Line 71:
 
==API==
 
==API==
  
The SatNOGS DB API is available to anyone at https://db.satnogs.org/api/
+
More info can be found in [[SatNOGS DB/API|API wiki page]].
More docs to come....
+
 
 +
==Documentation & Installation==
 +
 
 +
You can find documentation and installation instructions about the project in our [https://docs.satnogs.org/projects/satnogs-db/en/stable/ Read the Docs instance].
  
==Installation==
+
==See also==
  
===[https://docs.satnogs.org/en/stable/satnogs-db/docs/installation-docker.html Docker Installation]===
+
*[[SatNOGS Network]]
 +
*[https://libre.space/2020/03/02/space-situational-awareness/ Space Situational Awareness – The story so far and an open way forward]
  
===[https://docs.satnogs.org/en/stable/satnogs-db/docs/installation-virtualenv.html VirtualEnv Installation]===
+
[[Category:Infrastructure]]
 +
[[Category:Operate]]
 +
[[Category:Satellite]]
 +
[[Category:RF Modes]]

Latest revision as of 11:09, 14 August 2020


Introduction

SatNOGS DB is an effort to create a holistic, unified, global transmitter database for all satellite information. You can export the data or even connect your application using our API. It's part of the SatNOGS project.


Data

The DB is open to everyone. Anyone is able to submit suggestions or use the existing Transmitters. All data are public and freely under the Creative Commons Atribution-Share Alike license.

Contribute

Adding Satellites

If you are a moderator you can add new satellites on the DB. For that follow the instructions:

  1. Log in to db.satnogs.org
  2. Navigate to https://db.satnogs.org/admin (if you are seeing a login screen, you are either not logged in to db.satnogs.org, or don't have moderator permissions)
  3. Click on Base::Satellite Add button
  4. Complete the information to the best of your knowledge. NORAD ID and Name are mandatory. Add multiple names on the "Names" field.
  5. Click Save and you are done!
  6. You can now move on to the next steps: suggesting and approving transmitters for this satellite.

Note: this process may change in the future; see the Gitlab issues list for details.

Suggesting transmitters

Menu item to add new transmitter suggestion (for logged in users)
New transmitter suggestion (any logged in user can do it!)

We rely on crowd-sourced information to keep our transmitter details up to date. Anyone with a SatNOGS login can submit transmitter details. Moderators are notified and approve submissions frequently.

Navigate to the satellite you want to edit or suggest a new transmitter and click on the Edit menu while logged-in.

  • Description: This is the name that will appear for this transmitter across DB, Network, and API users. Please use the following notations
    • Band, for instance VHF, or for a transceiver, MODE U/V
    • Baud (if applicable), in the format 9k6 for 9600
    • Mode, for instance FSK
    • Rough type description, ie TLM for "telemetry", or "FM Transponder" for repeater
    • Examples
      • UHF 9k6 FSK TLM
      • MODE U/V FM Transceiver
      • VHF CW TLM
  • Type
    • Transmitter: one-way downlink (telemetry)
    • Transceiver: repeats an uplinked signal intact
    • Transponder: interacts with an uplinked signal or downlinks after signal modification
  • Status
    • Active: alive and well
    • Inactive: not functional or powered down
    • Invalid: this is a legacy or erroneous transmitter information that should be hidden from UI
  • Downlink Freq: Published frequency, in Hz
  • Downlink Drifted: Observed frequency, or what frequency should be used to properly tune (with doppler correction). In most cases this should be the same as the Downlink frequency. This field must be entered even if there is no drift.
  • Downlink Mode: The modulation mode for this transmitter
  • Baud rate: the baud rate, if applicable. If this is a CW beacon, use WPM
  • Citation URL: a URL to link to in providing the details for your suggestion. Include observations from SatNOGS Network and/or frequency coordination documentation.
  • Service: The ITU service that the transmitter can be categorized.

Approving transmitters

Review transmitter suggestion (for moderators only)

If you are a moderator you can approved suggestions for transmitters. For that follow the instructions:

  1. Log in to db.satnogs.org
  2. Navigate to the satellite page that has pending suggestions for transmitters
  3. Review the suggestion
  4. Decide to accept or reject it by clicking on the transmitter menu top right.

Note: this process may change in the future; see the Gitlab issues list for details.

Coding

Fluent in Python and/or JS? We need you to help with the satnogs-db web application! Take a look at our source code, or visit our issues tracker to start filling bugs, feature requests or code fixes for existing ones.

API

More info can be found in API wiki page.

Documentation & Installation

You can find documentation and installation instructions about the project in our Read the Docs instance.

See also