Difference between revisions of "SatNOGS DB"

From SatNOGS
(not a big enough page for a TOC)
(Docker Installation: Updating documentation links to point to pages that exist.)
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.
 
[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.
  
Line 7: Line 8:
 
==Contribute==
 
==Contribute==
  
=== Adding Satellites ===
+
===Adding Satellites===
 
If you are a moderator you can add new satellites on the DB. For that follow the instructions:
 
If you are a moderator you can add new satellites on the DB. For that follow the instructions:
# 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)
+
#Log in to db.satnogs.org
# Click on Base::Satellite [https://db.satnogs.org/admin/base/satellite/add/ Add button]
+
#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)
# Complete the information to the best of your knowledge. Norad ID and Name are mandatory. Add multiple names on the "Names" field.
+
#Click on Base::Satellite [https://db.satnogs.org/admin/base/satellite/add/ Add button]
# Click Save and you are done!
+
#Complete the information to the best of your knowledge. Norad ID and Name are mandatory. Add multiple names on the "Names" field.
# You can now move on to the next steps: suggesting and approving transmitters for this satellite.
+
#Click Save and you are done!
 +
#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 [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.
  
=== Suggesting transmitters ===
+
===Suggesting transmitters===
 
Detailed instructions on suggesting transmitters can be found [http://docs.satnogs.org/db/contribute.html here].
 
Detailed instructions on suggesting transmitters can be found [http://docs.satnogs.org/db/contribute.html here].
  
=== Approving transmitters ===
+
===Approving transmitters===
 
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
+
 
# 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)
+
#Log in to db.satnogs.org
# Click on Base::Suggestions
+
#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 the suggestion you want to review and carefully check the data, especially the citation URL
+
#Click on Base::Suggestions
# 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]
+
#Click on the suggestion you want to review and carefully check the data, especially the citation URL
# Select the suggestions you want to act upon and from the drop down above either approve them or reject them
+
#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]
# You are done!
+
#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 36: Line 39:
 
Fluent in Python and/or JS? We need you to help with the satnogs-db web application! Take a look at our [https://gitlab.com/librespacefoundation/satnogs/satnogs-db source code], or visit our [https://gitlab.com/librespacefoundation/satnogs/satnogs-db/issues? issues tracker] to start filling bugs, feature requests or code fixes for existing ones.
 
Fluent in Python and/or JS? We need you to help with the satnogs-db web application! Take a look at our [https://gitlab.com/librespacefoundation/satnogs/satnogs-db source code], or visit our [https://gitlab.com/librespacefoundation/satnogs/satnogs-db/issues? issues tracker] to start filling bugs, feature requests or code fixes for existing ones.
  
== API ==
+
==API==
  
 
The SatNOGS DB API is available to anyone at https://db.satnogs.org/api/
 
The SatNOGS DB API is available to anyone at https://db.satnogs.org/api/
Line 43: Line 46:
 
==Installation==
 
==Installation==
  
===[http://docs.satnogs.org/db/installation-docker.html Docker Installation]===
+
===[https://docs.satnogs.org/en/stable/satnogs-db/docs/installation-docker.html Docker Installation]===
  
===[http://docs.satnogs.org/db/installation-virtualenv.html VirtualEnv Installation]===
+
===[https://docs.satnogs.org/en/stable/satnogs-db/docs/installation-virtualenv.html VirtualEnv Installation]===

Revision as of 16:19, 16 May 2019


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.

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

Detailed instructions on suggesting transmitters can be found here.

Approving transmitters

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 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::Suggestions
  4. Click on the suggestion you want to review and carefully check the data, especially the citation URL
  5. When you are ready to approve or delete the suggestion, go back to the full list of suggestions
  6. Select the suggestions you want to act upon and from the drop down above either approve them or reject them
  7. You are done!

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

The SatNOGS DB API is available to anyone at https://db.satnogs.org/api/ More docs to come....

Installation

Docker Installation

VirtualEnv Installation