Projects/Edu/KStars/JuniorJobs: Difference between revisions

From KDE TechBase
< Projects‎ | Edu‎ | KStars
No edit summary
(13 intermediate revisions by 3 users not shown)
Line 10: Line 10:
See [https://mail.kde.org/mailman/listinfo/kstars-devel The List Information Page] to subscribe.
See [https://mail.kde.org/mailman/listinfo/kstars-devel The List Information Page] to subscribe.


If you prefer IRC, we hang out on #kde-edu on irc.freenode.org
If you prefer IRC, we hang out on #kde-kstars on irc.freenode.org


We keep track of bugs and wishlists on [https://bugs.kde.org The KDE bugzilla]
We keep track of bugs and wishlists on [https://bugs.kde.org The KDE bugzilla]
Line 17: Line 17:


== The Tasks ==
== The Tasks ==
<strike>
=== Update KStars Handbook ===
[https://docs.kde.org/stable5/en/kdeedu/kstars/index.html KStars Manual] is a detailed guide for end users to explore all the features and functionality of KStars in great depth. Sometimes KStars developers get very busy working on improving code and adding features while neglecting to update the handbook. Furthermore, a lot of the screenshots in the handbook are out of date. The task involves going over the handbook, which is written in a simple [http://www.docbook.org/ DocBook] format, and editing it as necessary to reflect the latest KStars release. This includes capturing and editing screenshots to replace old ones or add new screen captures where necessary.
Absolutely no programming knowledge is necessary, just use KStars and update the handbook as needed!
</strike>
Job Completed Successfully by '''Cojocaru Raphael'''!
<strike>
=== Improve Altitude vs. Time tool ===
KStars Altitude vs. Time tool is one of the widely used tools in KStars and enables the user to plot objects' altitude changes versus time. Improve the tool to enable zoom and pan operations, and also to mark rise/transit/set times on the tool. The tool depends on the venerable KDE Plotting Library which was developed by KStars original author Jason Harris. However, KStars now also uses the [http://www.qcustomplot.com/ QCustomPlot] library which provides several improvements over the standard KDE plotting library. You can either keep using the existing KDE Plotting Library or migrate the tool to QCustomPlot with the following features:
* Zoom/Pan
* Rise/Transit/Set markers (if not cirumpolar). If the object is not circumpolar, add three buttons for Rise/Transit/Set. When clicking these buttons, the crosshair on the plot is updated to the new time/altitude intersection.
* Input boxes for both Time and Altitude: If a user changes the time, the altitude at that time is displayed. If the user changes the altitude, the time of that altitude is displayed.
</strike>
Job Completed Successfully by '''Cojocaru Raphael'''!
=== Display FWHM and Star Profile in FITS Viewer ===
KStars FITS Viewer tool can calculate the overall Half-Flux-Radius (HFR) of stars in an image by summing each star's own HFR and then taking the average. Some users are interested to know the HFR of a single star, in addition to Full-Width-Half-Modulation (FWHM) and star profile (pixel distance from center vs. intensity). A tool-tip like popup when clicking on individual stars in the FITS image would be ideal as it would give users a quick access to some important information regarding a particular star.
Start by looking at how stars are detected and how HFR is calculated in FITSData class. Then calculate FWHM and construct a simple stellar profile diagram if the user clicks on a particular star.
<strike>
=== Port What's Interesting tool to QML 2 ===
What's Interesting is a KStars tool written in QML/QtQuick 1.0 that finds the most interesting objects visible to the user given light pollution levels among other parameters. With the migration to Qt5, the tool is not longer operational and requires porting to QML 2. Most of the migration work for QML 2 is complete, but someone needs to take on the last extra mile to get it in a working condition again.
</strike>
Job Completed Successfully by '''Artem Fedoskin'''!
=== Auto-suggest well-placed objects for observation / imaging ===
'''Aim:''' To auto-suggest objects that are well-placed in the night sky to users
'''Step 1:''' Move the wishlist feature into a database and support multiple wishlists, and rename it to something else. Ship pre-loaded wish-lists along with KStars, of varying levels of difficulty / experience / instrument requirements.
'''Step 2:''' Create a backend that will efficiently determine which objects are well-placed (lower than some threshold airmass set by the user) from one or more wishlists.
'''Step 3:''' Create a UI that will present one well-placed object to the user. The user may skip objects / cycle through suggestions. Skipped objects should not be displayed for a long time.
For more details, contact Akarsh Simha
=== DSS Overlay ===
Superimpose DSS images unto the SkyMap at different zoom levels. The user would be able to turn on/off the overlay which would be useful in checking what the real sky actually looks like at this exact location and at this particular zoom level. The overlay has to be consistent with the projection system in use, and must be careful not to tax the user's RAM (i.e. uses progressive smart loading) and should be usable on low-powered devices as well.
Contact Jasem or Akarsh for more details.


=== Debug the Sky Calendar ===
=== Debug the Sky Calendar ===


The Sky Calendar tool lives in the Tools menu of KStars. The tool now has the labels that it needed badly. However, some lines still don't get labelled because the code isn't robust. The tool also fails at high latitudes. It would be helpful if the Sky Calendar was made complete and bug-free.
The Sky Calendar tool lives in the Tools menu of KStars. The tool now has the labels that it needed badly. However, some lines still don't get labelled because the code isn't robust. The tool also fails at high latitudes. It would be helpful if the Sky Calendar was made complete and bug-free.
=== Debug the Conjunction tool ===
The Conjunction tool, for some reason, doesn't seem to be predicting solar eclipses correctly. There are some bugs on our bugzilla related to this as well. It would be useful if the Conjunction tool were made completely bug-free


=== Add Lunar Eclipses ===
=== Add Lunar Eclipses ===
Line 34: Line 84:
Another possible way to do it is to add functionality to KSMoon, so that we check if the moon is in the shadow of the earth before drawing its image.
Another possible way to do it is to add functionality to KSMoon, so that we check if the moon is in the shadow of the earth before drawing its image.


=== Fix the angular distance ruler crash ===
=== Fix refraction bugs ===
 
Because the refraction correction and its inverse are not perfect inverses, there are a whole bunch of problems when refraction corrections are turned on. It would greatly help KStars if this was fixed.
There's an irritating crash condition on our bugzilla where trying to measure angular distances hangs KStars under some conditions. The backtrace is right there. It will be useful if this is fixed.


=== Fix all those translation bugs ===
=== Fix all those translation bugs ===
Line 49: Line 98:
Implementing this will fix a whole lot of translation-related bugs that are on our bugzilla, and make life for people who use localized versions easier.
Implementing this will fix a whole lot of translation-related bugs that are on our bugzilla, and make life for people who use localized versions easier.


=== Generalize JupiterMoons, SaturnMoons ===
=== Generalize JupiterMoons ===


This was originally a GSoC idea, but I thought it was a bit too "small" for a whole summer. The idea is to implement a class that handles moons of planets in the solar system in KStars.
This was originally a GSoC idea, but I thought it was a bit too "small" for a whole summer. The idea is to implement a class that handles moons of planets in the solar system in KStars.


Currently, we have JupiterMoons and SaturnMoons (thanks, Vipul!) classes. What should be done now, is to pack all the machinery that goes into these two classes into one generic class (probably called 'SolarSystemMoons'), various instances of which, could represent the moons of Jupiter, Saturn, Mars...
Currently, we have the JupiterMoons classes. What should be done now, is to pack the machinery that goes into this class into a generic class (probably called 'SolarSystemMoons'), various instances of which, could represent the moons of Jupiter, Saturn, Mars...


All our class would need to do, to assume the form of say, JupiterMoons, would be to read off data corresponding to JupiterMoons from some file, say "solarsystemmoons.dat"!
All our class would need to do, to assume the form of say, JupiterMoons, would be to read off data corresponding to JupiterMoons from some file, say "solarsystemmoons.dat"!
Line 73: Line 122:
Re-implement CometsComponent::draw() to draw better comets.
Re-implement CometsComponent::draw() to draw better comets.


Charles Peng has already done a good amount of work to support this feature. It needs some polishing, though.
Peng "Charles" Chang has already done a good amount of work to support this feature. It needs some polishing, though.


And...
And...
=== Fix those inconsistencies with comets ===
=== Fix those inconsistencies with comets ===


Jeamy Lee, a KStars user and contributor, notices that our Sun-Comet distances are wrong! This makes all calculated parameters come out incorrectly. Find his mail with some details [http://lists.kde.org/?l=kstars-devel&m=123454066010918&w=2 here].
Jeamy Lee, a KStars user and contributor, notices that our Sun-Comet distances are wrong! This makes all calculated parameters come out incorrectly. Find his mail with some details [http://lists.kde.org/?l=kstars-devel&m=123454066010918&w=2 here].
 
The aim of this task is to compare some more data against other software, step through the code, and find out where we are going wrong. You could use Jeamy's MPC Reader site to download the [http://mpcreader.sourceforge.net/ latest comet elements] in KStars' format.


== Ideas are welcome! ==
== Ideas are welcome! ==


If you are a user of KStars and have some cool, simple ideas that would make your experience with KStars better, you are welcome to add them to the list above, or discuss them on the kstars-devel mailing list (or post them as wishlists / bug reports on the bugzilla).
If you are a user of KStars and have some cool, simple ideas that would make your experience with KStars better, you are welcome to add them to the list above, or discuss them on the kstars-devel mailing list (or post them as wishlists / bug reports on the bugzilla).

Revision as of 07:41, 4 September 2016

What this page is about

This page is intended to list out some small jobs that, if completed, would help KStars become better and more usable. There are both easy ones and hard ones.

If you are interested in contributing to KStars, but don't know where to start, this is probably the best place.

Keeping track of Development

The best way to keep track of Development in KStars is to use the mailing list: [email protected] See The List Information Page to subscribe.

If you prefer IRC, we hang out on #kde-kstars on irc.freenode.org

We keep track of bugs and wishlists on The KDE bugzilla

Please do not hesitate to ask if you need help with contributing! We're always looking out for contributors and will be happy to help you out.

The Tasks

Update KStars Handbook

KStars Manual is a detailed guide for end users to explore all the features and functionality of KStars in great depth. Sometimes KStars developers get very busy working on improving code and adding features while neglecting to update the handbook. Furthermore, a lot of the screenshots in the handbook are out of date. The task involves going over the handbook, which is written in a simple DocBook format, and editing it as necessary to reflect the latest KStars release. This includes capturing and editing screenshots to replace old ones or add new screen captures where necessary.

Absolutely no programming knowledge is necessary, just use KStars and update the handbook as needed!

Job Completed Successfully by Cojocaru Raphael!

Improve Altitude vs. Time tool

KStars Altitude vs. Time tool is one of the widely used tools in KStars and enables the user to plot objects' altitude changes versus time. Improve the tool to enable zoom and pan operations, and also to mark rise/transit/set times on the tool. The tool depends on the venerable KDE Plotting Library which was developed by KStars original author Jason Harris. However, KStars now also uses the QCustomPlot library which provides several improvements over the standard KDE plotting library. You can either keep using the existing KDE Plotting Library or migrate the tool to QCustomPlot with the following features:

  • Zoom/Pan
  • Rise/Transit/Set markers (if not cirumpolar). If the object is not circumpolar, add three buttons for Rise/Transit/Set. When clicking these buttons, the crosshair on the plot is updated to the new time/altitude intersection.
  • Input boxes for both Time and Altitude: If a user changes the time, the altitude at that time is displayed. If the user changes the altitude, the time of that altitude is displayed.

Job Completed Successfully by Cojocaru Raphael!


Display FWHM and Star Profile in FITS Viewer

KStars FITS Viewer tool can calculate the overall Half-Flux-Radius (HFR) of stars in an image by summing each star's own HFR and then taking the average. Some users are interested to know the HFR of a single star, in addition to Full-Width-Half-Modulation (FWHM) and star profile (pixel distance from center vs. intensity). A tool-tip like popup when clicking on individual stars in the FITS image would be ideal as it would give users a quick access to some important information regarding a particular star.

Start by looking at how stars are detected and how HFR is calculated in FITSData class. Then calculate FWHM and construct a simple stellar profile diagram if the user clicks on a particular star.

Port What's Interesting tool to QML 2

What's Interesting is a KStars tool written in QML/QtQuick 1.0 that finds the most interesting objects visible to the user given light pollution levels among other parameters. With the migration to Qt5, the tool is not longer operational and requires porting to QML 2. Most of the migration work for QML 2 is complete, but someone needs to take on the last extra mile to get it in a working condition again.

Job Completed Successfully by Artem Fedoskin!

Auto-suggest well-placed objects for observation / imaging

Aim: To auto-suggest objects that are well-placed in the night sky to users

Step 1: Move the wishlist feature into a database and support multiple wishlists, and rename it to something else. Ship pre-loaded wish-lists along with KStars, of varying levels of difficulty / experience / instrument requirements.

Step 2: Create a backend that will efficiently determine which objects are well-placed (lower than some threshold airmass set by the user) from one or more wishlists.

Step 3: Create a UI that will present one well-placed object to the user. The user may skip objects / cycle through suggestions. Skipped objects should not be displayed for a long time.

For more details, contact Akarsh Simha

DSS Overlay

Superimpose DSS images unto the SkyMap at different zoom levels. The user would be able to turn on/off the overlay which would be useful in checking what the real sky actually looks like at this exact location and at this particular zoom level. The overlay has to be consistent with the projection system in use, and must be careful not to tax the user's RAM (i.e. uses progressive smart loading) and should be usable on low-powered devices as well.

Contact Jasem or Akarsh for more details.

Debug the Sky Calendar

The Sky Calendar tool lives in the Tools menu of KStars. The tool now has the labels that it needed badly. However, some lines still don't get labelled because the code isn't robust. The tool also fails at high latitudes. It would be helpful if the Sky Calendar was made complete and bug-free.

Add Lunar Eclipses

KStars doesn't predict Lunar Eclipses. Neither does it display them. It would be really useful if it could do these things.

One way to do this would be to create a virtual Sky Point, maybe called 'EarthShadow', whose position would be just opposite the sun. An eclipse will be a conjunction between EarthShadow and the moon.

Another possible way to do it is to add functionality to KSMoon, so that we check if the moon is in the shadow of the earth before drawing its image.

Fix refraction bugs

Because the refraction correction and its inverse are not perfect inverses, there are a whole bunch of problems when refraction corrections are turned on. It would greatly help KStars if this was fixed.

Fix all those translation bugs

Now, this is a big task.

SkyObject classes (see skyobject.h under kstars/skyobjects) should have some standard way of storing names. Currently, some SkyObjects store untranslated names and some store translated names, leading to a big mess. SkyObject should probably store untranslated name strings internally, and return untranslated names upon calling name(). The objectNames() hashes should ideally have untranslated names as well.

So how do we find by translated name? The best way, probably is to have a "reverse translation hash". Since very few objects have translated names, it might be easy to maintain a global hash of translated names vs. untranslated names in some convenient place (probably as a static member of SkyComposite) and do searches for translated names through this.

Implementing this will fix a whole lot of translation-related bugs that are on our bugzilla, and make life for people who use localized versions easier.

Generalize JupiterMoons

This was originally a GSoC idea, but I thought it was a bit too "small" for a whole summer. The idea is to implement a class that handles moons of planets in the solar system in KStars.

Currently, we have the JupiterMoons classes. What should be done now, is to pack the machinery that goes into this class into a generic class (probably called 'SolarSystemMoons'), various instances of which, could represent the moons of Jupiter, Saturn, Mars...

All our class would need to do, to assume the form of say, JupiterMoons, would be to read off data corresponding to JupiterMoons from some file, say "solarsystemmoons.dat"!

Now, the next task...

Generalize the Jupiter's Moons Tool

See Tools -> Jupiter's Moons. What if I could do this in general with SolarSystemMoons? [See earlier task for details]

Comets that looks like comets!

Comets in KStars are currently drawn as dull green circles (at least in the default color scheme). That's not what they look like, in reality!

The machinery required to estimate nucleus and coma sizes, and tail lengths of comets are all there in KSComet and KSPlanetBase. What needs to be done, is to provide a proper representation of a comet based on these data on the Sky Map.

Remember that a comet's tail points away from the Sun! You can use this to fix the direction of the tail - so you have all information required to draw the comet.

Re-implement CometsComponent::draw() to draw better comets.

Peng "Charles" Chang has already done a good amount of work to support this feature. It needs some polishing, though.

And...

Fix those inconsistencies with comets

Jeamy Lee, a KStars user and contributor, notices that our Sun-Comet distances are wrong! This makes all calculated parameters come out incorrectly. Find his mail with some details here.

Ideas are welcome!

If you are a user of KStars and have some cool, simple ideas that would make your experience with KStars better, you are welcome to add them to the list above, or discuss them on the kstars-devel mailing list (or post them as wishlists / bug reports on the bugzilla).