Pulsars plugin

From Stellarium Wiki
(Difference between revisions)
Jump to: navigation, search
m (Version history)
(Version history)
 
(13 intermediate revisions by one user not shown)
Line 4: Line 4:
 
Example ([http://en.wikipedia.org/wiki/PSR_B0329+54 PSR J0332+5434]):
 
Example ([http://en.wikipedia.org/wiki/PSR_B0329+54 PSR J0332+5434]):
 
   
 
   
http://astro.uni-altai.ru/~aw/stellarium/psr_j0332_5434.jpg
+
http://stellarium.org/wikiimg/pulsars/psr_j0332_5434.jpg
  
 
==Using the Pulsars plugin==
 
==Using the Pulsars plugin==
 
#Enable the tool by clicking the tool-bar button "Load at startup"
 
#Enable the tool by clicking the tool-bar button "Load at startup"
 
#Find the pulsar by their designation (PSR J0437-4715 as example)
 
#Find the pulsar by their designation (PSR J0437-4715 as example)
 +
 +
==Section [Pulsars] in config.ini file==
 +
You can edit <tt>config.ini</tt> file by yourself for changes of the settings for the Pulsars plugin - just make it carefully!
 +
 +
{| class="guidetable"
 +
| rowspan="2" | ''ID''
 +
| rowspan="2" | ''Type''
 +
| colspan="2" style="text-align:center;" | ''Version''
 +
| rowspan="2" | ''Description''
 +
|-
 +
| ''Plugin''
 +
| ''Stellarium''
 +
|-
 +
|last_update
 +
|string
 +
|0.2.1+
 +
|0.11.4+
 +
|Date and time of last update
 +
|-
 +
|update_frequency_days
 +
|int
 +
|0.2.1+
 +
|0.11.4+
 +
|Frequency of updates, in days
 +
|-
 +
|updates_enable
 +
|bool
 +
|0.2.1+
 +
|0.11.4+
 +
|Enable updates of pulsars catalog from Internet
 +
|-
 +
|url
 +
|string
 +
|0.2.1+
 +
|0.11.4+
 +
|URL of pulsars catalog
 +
|-
 +
|enable_at_startup
 +
|bool
 +
|0.2.7+
 +
|0.12.2+
 +
|Enable displaying of pulsars at startup of planetarium
 +
|-
 +
|distribution_enabled
 +
|bool
 +
|0.2.2+
 +
|0.12.0+
 +
|Enable distribution mode for the pulsars
 +
|-
 +
|flag_show_pulsars_button
 +
|bool
 +
|0.2.7+
 +
|0.12.2+
 +
|Enable displaying pulsars button on toolbar
 +
|-
 +
|marker_color
 +
|R,G,B
 +
|0.2.12+
 +
|0.13.0+
 +
|Color for marker of the pulsars
 +
|-
 +
|glitch_color
 +
|R,G,B
 +
|0.2.12+
 +
|0.13.0+
 +
|Color for marker of the pulsars with glitches
 +
|-
 +
|use_separate_colors
 +
|bool
 +
|0.2.12+
 +
|0.13.0+
 +
|Use separate colors for different types of the pulsars
 +
|}
  
 
==Catalog of pulsars==
 
==Catalog of pulsars==
You can modify the <tt>catalog.json</tt> file manually using a text editor. '''If you are using Windows, it is strongly recommended to use an advanced text editor such as [http://notepad-plus-plus.org/ Notepad++]''' to avoid problems with end-of-line characters. (It will also color the JSON code and make it easier to read.)  
+
You can modify the <tt>catalog.json</tt> (for 0.1.x) or <tt>pulsars.json</tt> (for 0.2.x) file manually using a text editor. '''If you are using Windows, it is strongly recommended to use an advanced text editor such as [http://notepad-plus-plus.org/ Notepad++]''' to avoid problems with end-of-line characters. (It will also color the JSON code and make it easier to read.)  
  
'''Warning''': Before editing your <tt>catalog.json</tt>, make a backup copy. Leaving out the smallest detail (such as a comma or forgetting to close a curly bracket) will prevent Stellarium from starting.  
+
'''Warning''': Before editing your JSON file, make a backup copy. Leaving out the smallest detail (such as a comma or forgetting to close a curly bracket) will prevent Stellarium from starting.  
  
The path to the directory which contains <tt>catalog.json</tt> is something like:  
+
The path to the directory which contains <tt>catalog.json</tt> or <tt>pulsars.json</tt> is something like:  
 
{{user data directory|modules\Pulsars|modules/Pulsars}}
 
{{user data directory|modules\Pulsars|modules/Pulsars}}
  
Line 106: Line 179:
 
  | First public version of plugin
 
  | First public version of plugin
 
  |-
 
  |-
  | ''0.2.0''
+
  | 0.2.1
  | ''0.11.4''
+
  | 0.11.4
 
  | 2
 
  | 2
 
  | Enhance catalog of pulsars. Added GUI to plug-in.
 
  | Enhance catalog of pulsars. Added GUI to plug-in.
 
  |-
 
  |-
 +
| 0.2.2
 +
| 0.12.0
 +
| 2
 +
| Use new rendering engine of core
 +
|-
 +
| 0.2.7
 +
| 0.12.2
 +
| 2
 +
| Added the button to toggle pulsars on toolbar. Improvements for search tool. Updated code.
 +
|-
 +
| 0.2.12
 +
| 0.13.0
 +
| 2
 +
| Improvements for performance. Display pulsars with glitches. Setting color for marker for different types of the pulsars.
 
  |}
 
  |}
  

Latest revision as of 15:36, 19 July 2014

Contents

[edit] Description

This plugin plots the position of various pulsars, with object information about each one. Pulsar data is derived from Catalog of Pulsars (Taylor+ 1995) for 0.1.x series and derived from The ATNF Pulsar Catalogue (Manchester, R. N., Hobbs, G. B., Teoh, A. & Hobbs, M., Astron. J., 129, 1993-2006 (2005) (astro-ph/0412641)) for series 0.2.x.

Example (PSR J0332+5434):

psr_j0332_5434.jpg

[edit] Using the Pulsars plugin

  1. Enable the tool by clicking the tool-bar button "Load at startup"
  2. Find the pulsar by their designation (PSR J0437-4715 as example)

[edit] Section [Pulsars] in config.ini file

You can edit config.ini file by yourself for changes of the settings for the Pulsars plugin - just make it carefully!

ID Type Version Description
Plugin Stellarium
last_update string 0.2.1+ 0.11.4+ Date and time of last update
update_frequency_days int 0.2.1+ 0.11.4+ Frequency of updates, in days
updates_enable bool 0.2.1+ 0.11.4+ Enable updates of pulsars catalog from Internet
url string 0.2.1+ 0.11.4+ URL of pulsars catalog
enable_at_startup bool 0.2.7+ 0.12.2+ Enable displaying of pulsars at startup of planetarium
distribution_enabled bool 0.2.2+ 0.12.0+ Enable distribution mode for the pulsars
flag_show_pulsars_button bool 0.2.7+ 0.12.2+ Enable displaying pulsars button on toolbar
marker_color R,G,B 0.2.12+ 0.13.0+ Color for marker of the pulsars
glitch_color R,G,B 0.2.12+ 0.13.0+ Color for marker of the pulsars with glitches
use_separate_colors bool 0.2.12+ 0.13.0+ Use separate colors for different types of the pulsars

[edit] Catalog of pulsars

You can modify the catalog.json (for 0.1.x) or pulsars.json (for 0.2.x) file manually using a text editor. If you are using Windows, it is strongly recommended to use an advanced text editor such as Notepad++ to avoid problems with end-of-line characters. (It will also color the JSON code and make it easier to read.)

Warning: Before editing your JSON file, make a backup copy. Leaving out the smallest detail (such as a comma or forgetting to close a curly bracket) will prevent Stellarium from starting.

The path to the directory which contains catalog.json or pulsars.json is something like:

  • C:\Users\UserName\AppData\Roaming\Stellarium\modules\Pulsars (Windows Vista, Windows 7)
  • C:\Documents and Settings\UserName\Application Data\Stellarium\modules\Pulsars (Windows XP)
  • HomeDirectory/Library/Preferences/Stellarium/modules/Pulsars (Mac OS X)
  • ~/.stellarium/modules/Pulsars (Linux)

(Note that this is a hidden folder, so in order to find it you may need to change your computer's settings to display hidden files and folders.)

[edit] Format of catalog

To add a new pulsar, open a new line after line 5 and paste the following, note commas and brackets, they are important:

[edit] For plugin series 0.1.x (Catalog version 1)

             "Pulsar designation":
             {
                   "RA": "Right ascension (J2000)",
                   "DE": "Declination (J2000)",
                   "distance": value of distance to pulsar (kpc),
                   "period": value of baricentric period (s),
                   "ntype": octal code of type of pulsar,
                   "We": value of equivalent width of the integrated pulse profile (ms),
                   "w50": value of profile width at 50% of peak (ms),
                   "s400": value of time averaged flux density at 400 MHz (mJy),
                   "s600": value of time averaged flux density at 600 MHz (mJy),
                   "s1400": value of time averaged flux density at 1400 MHz (mJy)
             },

For example, record for PSR J0014+4746:

		"PSR J0014+4746":
		{
			"RA": "00h14m17.74s",
			"DE": "+47d46m33.1s",
			"distance": 1.84,
			"period": 1.2406989780800000,
			"ntype": 0,
			"We": 155.00,
			"w50": 88.70,
			"s400": 14.00,
			"s600": 9.00,
			"s1400": 3.00
		},

[edit] For plugin series 0.2.x (Catalog version 2)

             "Pulsar designation":
             {
                   "RA": "Right ascension (J2000)",
                   "DE": "Declination (J2000)",
                   "notes": "type of pulsar",
                   "distance": value of distance based on electron density model (kpc),
                   "period": value of barycentric period of the pulsar (s),
                   "parallax": value of annular parallax (mas),
                   "bperiod": value of binary period of pulsar (days),
                   "pderivative": value of time derivative of barcycentric period (dimensionless),
                   "dmeasure": value of dispersion measure (cm^-3 pc),
                   "frequency": value of barycentric rotation frequency (Hz),
                   "pfrequency": value of time derivative of barycentric rotation frequency (s^-2)
                   "eccentricity": value of eccentricity,                   
                   "w50": value of profile width at 50% of peak (ms),
                   "s400": value of time averaged flux density at 400 MHz (mJy),
                   "s600": value of time averaged flux density at 600 MHz (mJy),
                   "s1400": value of time averaged flux density at 1400 MHz (mJy)
             },

For example, record for PSR J0014+4746:

             "PSR J0014+4746":
             {
                   "distance": 1.82,
                   "dmeasure": 30.85,
                   "frequency": 0.805997239145,
                   "pfrequency": -3.6669E-16,
                   "w50": 88.7,
                   "s400": 14,
                   "s600": 9,
                   "s1400": 3,
                   "RA": "00h14m17.75s",
                   "DE": "47d46m33.4s"
             },

[edit] Version history

Plug-in version Stellarium version Catalog version Significant changes
0.1.2 0.11.2 1 First public version of plugin
0.2.1 0.11.4 2 Enhance catalog of pulsars. Added GUI to plug-in.
0.2.2 0.12.0 2 Use new rendering engine of core
0.2.7 0.12.2 2 Added the button to toggle pulsars on toolbar. Improvements for search tool. Updated code.
0.2.12 0.13.0 2 Improvements for performance. Display pulsars with glitches. Setting color for marker for different types of the pulsars.

[edit] Acknowledgment

We thank the following people for their contribution and of the valuable comments:

[edit] How you can help

We are welcome bug reports, feature requests and feedback through the usual channels (trackers, forums and so on).

Personal tools
Namespaces
Variants
Actions
in this wiki
other languages
Toolbox