about summary refs log tree commit diff
diff options
context:
space:
mode:
-rw-r--r--README.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bd27b48
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+# SatelliteComputation
+
+**Blender Required !!!**
+
+Start software like this:
+
+    blender --python main.py
+
+If you don't want to start blender and only want to get the raw data
+(console + matplotlib) start like this:
+
+    blender --python main.py --background
+
+## code:
+Download data from a specific category:
+
+     TLE.download(category)
+
+     example:
+     TLE.download("iridium")
+
+Get number of satellites in category:
+
+     TLE.numOfSat(category)
+
+     example:
+     TLE.numOfSat("noaa")
+
+Print specific TLE:
+
+     TLE.printTLE(category, satNr)
+
+     example:
+
+Get value from sat in category:
+
+     TLE.get(value, category, satNr)
+
+     example:
+     TLE.get("inclination", "argos", 3)
+
+xyz list:
+
+    xyz[satNr][x/y/z][time]