astropanel 1.1.6 → 2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +108 -0
  3. data/bin/astropanel +919 -1048
  4. metadata +11 -16
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6591cdec5082235e5fccfdefbc533df487fa4fda0b3d2c0a7218a813961f23a8
4
- data.tar.gz: 74cd1353b471afc5a150270ded607107465f72565d3b260d755a51e22f9451d3
3
+ metadata.gz: 86f36b0da5f8e2cbccf88545c4ee52d9923150f5432d44006a3f174871b06df1
4
+ data.tar.gz: e1d5f3a2665b71afee7f3f695af0628f574de095a62140af64b0e4801ab32c0d
5
5
  SHA512:
6
- metadata.gz: 79fe543ae189d2521ba6a4a267c7d0fcc9507a63e2fd9821b739f89a82bc53bcf0d2fbe8ba7f956d28c35d436ee479d1b011f8a612e25e697f2d4d0987af1768
7
- data.tar.gz: 93c13622e47e7fb68180d509fbc95d6e1b510c03c898cc3d12524057a88126c387fdecdd69484c71b4a486eb935080f19a50c9a5bdbc1a13a193ae4cf3242c80
6
+ metadata.gz: 1ec0ef9f77b314569ddb8f2ef71000b421335f32b82e73ab07ae25daa6683a439c5e1abc7ad86a28789eb0a0c5aff2213eb621bb19d3c8ff3bbe0c8d52826bb3
7
+ data.tar.gz: 0f6ca8e1e909ca7e88fb640a4f98de792a6e1e6bb6bcc13c7d3f022a4a45759916985d22ec160cd3f37b07cf4b4ffba8facccde378fcad76bbf16bb9a1afd3ea
data/README.md ADDED
@@ -0,0 +1,108 @@
1
+ # Astropanel
2
+
3
+ <img src="logo.jpg" align="left" width="150" height="150">Terminal program for
4
+ amateur astronomers with weather forecast, ephemeris, astronomical events and
5
+ more. It's what you need to decide wether to take your telescope out for a
6
+ spin.
7
+
8
+ **NOTE: 2.0: Full rewrite using [rcurses](https://github.com/isene/rcurses)**
9
+
10
+ Install by cloning this repo and putting `astropanel.rb` into your "bin"
11
+ directory. Or you can simply run `gem install astropanel`.
12
+
13
+ ## Functionality
14
+ This program gives you essential data to plan your observations:
15
+
16
+ * Weather forecast for the next 9 days with coloring (red/yellow/green) based
17
+ on your limits for cloud cover, humidity, temperature and wind
18
+ * Graphic representation of when the Sun, Moon and planets are visible
19
+ with the Moon's phase showing in how light the representing bar is
20
+ * Extra information for each day: Fog, wind gust speed, dew point temperature,
21
+ air pressure, UV Index, Sun and Moon precise rise and set and Moon phase.
22
+ The Moon phase is expressed as a number between 0 and 100 where 50 is the
23
+ full moon.
24
+ * Astronomical events for each of the 9 days, with option to list them in one
25
+ view
26
+ * Star chart showing in the terminal for the selected day and time of day
27
+ PS: The star chart is only generated for latitudes above +23
28
+ * A table showing RA, Dec, distance, rise, set and transit for the planets
29
+ * Show today's Astronomy Picture Of the Day
30
+
31
+ ## Condition rules
32
+ The rules to calculate whether the condition is green, yellow or red are:
33
+
34
+ * The limits you set will determine the "negative points" given
35
+ * With 4 or more negative points, the condition becomes red
36
+ * With 2 or 3 negative points, the condition is yellow
37
+ * Less than two negative points makes the condition green
38
+ * Two negative points are given if the cloud coverage exceeds your cloud limit
39
+ * Another negative point is given if the cloud coverage is more than (100 - cloud limit)/2
40
+ * Another negative point is given if the cloud coverage is above 90%
41
+ * A negative point is given if the humidity exceeds your humidity limit
42
+ * A negative point is given if the air temperature is below your temperature limit
43
+ * Another negative point is given if the temperature is below your temperature limit - 7°C
44
+ * A negative point is given if the wind exceeds your wind limit
45
+ * Another negative point is given if the wind exceeds twice your wind limit
46
+
47
+ ## Requirements
48
+ You need to have [Ruby](https://www.ruby-lang.org/en/) installed to use Astropanel.
49
+
50
+ Then there are two basic prerequisites needed: `x11-utils` and `xdotool`.
51
+
52
+ To have the star chart displayed, you need to have `imagemagick` and `w3m-img` installed.
53
+
54
+ To get all prerequisites installed on Ubuntu:
55
+ `apt-get install ruby-full git libncurses-dev x11-utils xdotool imagemagick w3m-img`
56
+
57
+ And on Arch:
58
+ `pacman -S ruby git xorg-xwininfo xdotool imagemagick w3m-img`
59
+
60
+ Also, images like the star chart and APOD is only reliably tested on the URXVT
61
+ terminal emulator.
62
+
63
+ ## Launching Astropanel
64
+ The first time you launch Astropanel (make astropanel.rb executable; `chmod +x
65
+ astropanel.rb` and run it), it will ask for your location, Latitude and
66
+ Longitude.
67
+
68
+ When you start the program, it will show you the list of forecast points for
69
+ today and the next 9 days (from https://met.no). The first couple of days are
70
+ detailed down to each hour, while the rest of the days have 4 forecast points
71
+ (hours 00, 06, 12 and 18). Time is for your local time zone.
72
+
73
+ When inside the program, you can set the various limits as you see fit.
74
+
75
+ ## Keys
76
+
77
+ Just press "?" to get the help for each possible key binding:
78
+
79
+ ```
80
+ KEYS
81
+ ? = Show this help text ENTER = Refresh starchart/image
82
+ l = Edit Location r = Redraw all panes and image
83
+ a = Edit Latitude R = Refresh all data (and re-fetch image)
84
+ o = Edit Longitude s = Get starchart for selected time
85
+ c = Edit Cloud limit S = Open starchart in image program
86
+ h = Edit Humidity limit A = Show Astronomy Picture Of the Day
87
+ t = Edit Temperature limit e = Show upcoming events
88
+ w = Edit Wind limit W = Write to config file
89
+ b = Edit Bortle value q = Quit (write to config file, Q = no write)
90
+ ```
91
+ These should be self explanatory. Until I can figure out how to automatically
92
+ fetch a location's Bortle value (light pollution), this is entered manually.
93
+
94
+ ## Quitting the program and saving configuration
95
+ Location values you change in the program are written to the config file when
96
+ you quit via "q". Use "Q" to quit without writing the values (if you want to
97
+ see the forecast for different locations and not overwrite your preferred
98
+ location data). Use 'W' to write new limit values to the config file.
99
+
100
+ In Termux for Android or environments where images can't be shown in a
101
+ terminal, set this in the config file (.ap.conf): `@noimage = true`
102
+
103
+ ## Screencast
104
+ Click on this screenshot to see a screencast that will give you a sense of how
105
+ this application works:
106
+
107
+ [![Astropanel screencast](/screenshot.png)](https://youtu.be/36jsu3YBLyw)
108
+