SpiralMap 0.0.12__tar.gz → 0.0.21__tar.gz

{spiralmap-0.0.12 → spiralmap-0.0.21}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: SpiralMap
-Version: 0.0.12
+Version: 0.0.21
 Summary: Python Library of Milky Way's Spiral Arms
 Project-URL: Homepage, https://github.com/Abhaypru/SpiralMap
 Project-URL: Issues, https://github.com/Abhaypru/SpiralMap/issues
@@ -26,19 +26,15 @@ The detailed documentation is hosted on [Read the docs](https://spiralmap.readth
 
 For a quickstart please refer to the accompanying [Jupyter notebook](https://github.com/Abhaypru/SpiralMap/blob/main/demo_spiralmap.ipynb)
 
-
 ## Features
 + Access 8 independent spiral arm models from literature. We are open to requests for including other spiral arm models. 
 + Extract the 2D trace of individual or all spiral arms from a particular model.
 + Directly overplot spiral arms with choice of Cartesian or Polar coordinates, and in Heliocentric or Galactocentric frames.
 
-
-
-![image info](src/SpiralMap/figdir_primer/polar_proj_multiple_models2.png).
+![image info](src/SpiralMap/movie_.gif).
 
 Shown above is a gallery of the spiral models & maps included in the current version. 
 
-
 Installation
 -------------
 
@@ -48,11 +44,10 @@ Install the latest released version using ``pip``:
    pip install SpiralMap
 ```
 
-
 Acknowledging ``SpiralMap``
 ---------------------------------------
-If you make use of our package, please cite the accompanying JOSS paper (link). 
+If you make use of our package, please cite the accompanying paper. 
 
-Additionally, please also cite the individual spiral model used. To facilitate this, we provide a BibTex file with the relevant citations in 'datafiles/spiral.bib' (here on GitHub),
+Additionally, please also cite the individual spiral model used. To facilitate this, we provide a BibTex file with the relevant citations in 'datafiles/spiral.bib' (on GitHub),
 or alternatively these are also available on [Read the docs](https://spiralmap.readthedocs.io/en/latest/#api-docs).
 

{spiralmap-0.0.12 → spiralmap-0.0.21}/README.md

@@ -8,19 +8,15 @@ The detailed documentation is hosted on [Read the docs](https://spiralmap.readth
 
 For a quickstart please refer to the accompanying [Jupyter notebook](https://github.com/Abhaypru/SpiralMap/blob/main/demo_spiralmap.ipynb)
 
-
 ## Features
 + Access 8 independent spiral arm models from literature. We are open to requests for including other spiral arm models. 
 + Extract the 2D trace of individual or all spiral arms from a particular model.
 + Directly overplot spiral arms with choice of Cartesian or Polar coordinates, and in Heliocentric or Galactocentric frames.
 
-
-
-![image info](src/SpiralMap/figdir_primer/polar_proj_multiple_models2.png).
+![image info](src/SpiralMap/movie_.gif).
 
 Shown above is a gallery of the spiral models & maps included in the current version. 
 
-
 Installation
 -------------
 
@@ -30,11 +26,10 @@ Install the latest released version using ``pip``:
    pip install SpiralMap
 ```
 
-
 Acknowledging ``SpiralMap``
 ---------------------------------------
-If you make use of our package, please cite the accompanying JOSS paper (link). 
+If you make use of our package, please cite the accompanying paper. 
 
-Additionally, please also cite the individual spiral model used. To facilitate this, we provide a BibTex file with the relevant citations in 'datafiles/spiral.bib' (here on GitHub),
+Additionally, please also cite the individual spiral model used. To facilitate this, we provide a BibTex file with the relevant citations in 'datafiles/spiral.bib' (on GitHub),
 or alternatively these are also available on [Read the docs](https://spiralmap.readthedocs.io/en/latest/#api-docs).
 

{spiralmap-0.0.12 → spiralmap-0.0.21}/docs/build/html/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: be0e9c005fef897c4d1b1c720bd32e89
+config: bce49989f93d3b259d765edfdc6a394e
 tags: 645f666f9bcd5a90fca523b33c5a78b7

{spiralmap-0.0.12 → spiralmap-0.0.21}/docs/build/html/_modules/SpiralMap/models_.html

@@ -16,6 +16,13 @@
       <script src="../../_static/documentation_options.js?v=f2a433a1"></script>
       <script src="../../_static/doctools.js?v=9a2dae69"></script>
       <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
+      <script src="https://www.googletagmanager.com/gtag/js?id=G-2D1BGW81C9"></script>
+      <script>
+        window.dataLayer = window.dataLayer || [];
+        function gtag(){dataLayer.push(arguments);}
+        gtag('js', new Date());
+        gtag('config', 'G-2D1BGW81C9');
+    </script>
     <script src="../../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../../genindex.html" />
     <link rel="search" title="Search" href="../../search.html" /> 
@@ -290,7 +297,7 @@
 <div class="viewcode-block" id="spiral_houhan">
 <a class="viewcode-back" href="../../api.html#SpiralMap.models_.spiral_houhan">[docs]</a>
 <span class="k">class</span> <span class="nc">spiral_houhan</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>	
-<span class="w">	</span><span class="sd">&quot;&quot;&quot;Hou &amp; Han (2014) polynomial-logarithmic spiral arm model</span>
+<span class="w">	</span><span class="sd">&quot;&quot;&quot;Hou &amp; Han (2014) polynomial-logarithmic spiral arm model, all tracers</span>
 <span class="sd">	</span>
 <span class="sd">	Implements the Milky Way spiral structure model from:</span>
 <span class="sd">	&quot;The spiral structure of the Milky Way from classical Cepheids&quot; (Hou &amp; Han 2014)</span>
@@ -315,7 +322,7 @@
 <a class="viewcode-back" href="../../api.html#SpiralMap.models_.spiral_houhan.getparams">[docs]</a>
 	<span class="k">def</span> <span class="nf">getparams</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>						
 <span class="w">		</span><span class="sd">&quot;&quot;&quot;			</span>
-<span class="sd">		   Load spiral parameters from Hou &amp; Han (2014) Table 4.</span>
+<span class="sd">		   Load spiral parameters from Hou &amp; Han (2014) Table 4 (vcirc=239, Z =0.16), all tracers.</span>
 <span class="sd">		   </span>
 <span class="sd">		   :return: params ( Nested dictionary containing for each arm).</span>
 <span class="sd">		   </span>
@@ -325,7 +332,127 @@
 <span class="sd">					</span>
 <span class="sd">					θ_end: End angle in degrees.		   		   </span>
 <span class="sd">		   :rtype: dict </span>
-<span class="sd">		&quot;&quot;&quot;</span>					
+<span class="sd">		&quot;&quot;&quot;</span>			
+		<span class="n">params</span> <span class="o">=</span> <span class="p">{</span>
+			<span class="s1">&#39;Norma&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;a&#39;</span><span class="p">:</span> <span class="mf">1.1320</span><span class="p">,</span> <span class="s1">&#39;b&#39;</span><span class="p">:</span> <span class="mf">0.1233</span><span class="p">,</span> <span class="s1">&#39;c&#39;</span><span class="p">:</span> <span class="mf">0.003488</span><span class="p">,</span> <span class="s1">&#39;d&#39;</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span> <span class="s1">&#39;θ_start&#39;</span><span class="p">:</span> <span class="mi">40</span><span class="p">,</span> <span class="s1">&#39;θ_end&#39;</span><span class="p">:</span> <span class="mi">250</span><span class="p">},</span>
+			<span class="s1">&#39;Scutum-Centaurus&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;a&#39;</span><span class="p">:</span> <span class="mf">5.8243</span><span class="p">,</span> <span class="s1">&#39;b&#39;</span><span class="p">:</span> <span class="o">-</span><span class="mf">1.8196</span><span class="p">,</span> <span class="s1">&#39;c&#39;</span><span class="p">:</span> <span class="mf">0.2350</span><span class="p">,</span> <span class="s1">&#39;d&#39;</span><span class="p">:</span> <span class="o">-</span><span class="mf">0.009011</span><span class="p">,</span> <span class="s1">&#39;θ_start&#39;</span><span class="p">:</span> <span class="mi">275</span><span class="p">,</span> <span class="s1">&#39;θ_end&#39;</span><span class="p">:</span> <span class="mi">620</span><span class="p">},</span>
+			<span class="s1">&#39;Sagittarius-Carina&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;a&#39;</span><span class="p">:</span> <span class="mf">4.2767</span><span class="p">,</span> <span class="s1">&#39;b&#39;</span><span class="p">:</span> <span class="o">-</span><span class="mf">1.1507</span><span class="p">,</span> <span class="s1">&#39;c&#39;</span><span class="p">:</span> <span class="mf">0.1570</span><span class="p">,</span> <span class="s1">&#39;d&#39;</span><span class="p">:</span> <span class="o">-</span><span class="mf">0.006078</span><span class="p">,</span> <span class="s1">&#39;θ_start&#39;</span><span class="p">:</span> <span class="mi">275</span><span class="p">,</span> <span class="s1">&#39;θ_end&#39;</span><span class="p">:</span> <span class="mi">575</span><span class="p">},</span>
+			<span class="s1">&#39;Perseus&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;a&#39;</span><span class="p">:</span> <span class="mf">1.1280</span><span class="p">,</span> <span class="s1">&#39;b&#39;</span><span class="p">:</span> <span class="mf">0.1282</span><span class="p">,</span> <span class="s1">&#39;c&#39;</span><span class="p">:</span> <span class="mf">0.002617</span><span class="p">,</span> <span class="s1">&#39;d&#39;</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span> <span class="s1">&#39;θ_start&#39;</span><span class="p">:</span> <span class="mi">280</span><span class="p">,</span> <span class="s1">&#39;θ_end&#39;</span><span class="p">:</span> <span class="mi">500</span><span class="p">},</span>
+			<span class="s1">&#39;Local&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;a&#39;</span><span class="p">:</span> <span class="mf">1.7978</span><span class="p">,</span> <span class="s1">&#39;b&#39;</span><span class="p">:</span> <span class="o">-</span><span class="mf">0.04738</span><span class="p">,</span> <span class="s1">&#39;c&#39;</span><span class="p">:</span> <span class="mf">0.01684</span><span class="p">,</span> <span class="s1">&#39;d&#39;</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span> <span class="s1">&#39;θ_start&#39;</span><span class="p">:</span> <span class="mi">280</span><span class="p">,</span> <span class="s1">&#39;θ_end&#39;</span><span class="p">:</span> <span class="mi">500</span><span class="p">},</span>
+			<span class="s1">&#39;Outer&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;a&#39;</span><span class="p">:</span> <span class="mf">2.4225</span><span class="p">,</span> <span class="s1">&#39;b&#39;</span><span class="p">:</span> <span class="o">-</span><span class="mf">0.1636</span><span class="p">,</span> <span class="s1">&#39;c&#39;</span><span class="p">:</span> <span class="mf">0.02494</span><span class="p">,</span> <span class="s1">&#39;d&#39;</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span> <span class="s1">&#39;θ_start&#39;</span><span class="p">:</span> <span class="mi">280</span><span class="p">,</span> <span class="s1">&#39;θ_end&#39;</span><span class="p">:</span> <span class="mi">405</span><span class="p">}</span>
+		<span class="p">}</span>	
+		<span class="k">return</span> <span class="n">params</span>		</div>
+
+<div class="viewcode-block" id="spiral_houhan.polynomial_log_spiral">
+<a class="viewcode-back" href="../../api.html#SpiralMap.models_.spiral_houhan.polynomial_log_spiral">[docs]</a>
+	<span class="k">def</span> <span class="nf">polynomial_log_spiral</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">θ</span><span class="p">,</span> <span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">c</span><span class="p">,</span> <span class="n">d</span><span class="p">):</span>		
+<span class="w">		</span><span class="sd">&quot;&quot;&quot;Calculate radius using polynomial-logarithmic spiral equation.</span>
+<span class="sd">		</span>
+<span class="sd">		Parameters</span>
+<span class="sd">		----------</span>
+<span class="sd">		θ : float or ndarray</span>
+<span class="sd">			Galactic longitude angle in degrees</span>
+<span class="sd">		a,b,c,d : float</span>
+<span class="sd">			Polynomial coefficients from Hou &amp; Han Table 4</span>
+<span class="sd">			</span>
+<span class="sd">		Returns</span>
+<span class="sd">		-------</span>
+<span class="sd">		float or ndarray</span>
+<span class="sd">			Galactocentric radius in kiloparsecs</span>
+<span class="sd">			</span>
+<span class="sd">		Notes</span>
+<span class="sd">		-----</span>
+<span class="sd">		Implements equation:</span>
+<span class="sd">		R(θ) = exp(a + bθ_rad + cθ_rad² + dθ_rad³)</span>
+<span class="sd">		where θ_rad = np.radians(θ)</span>
+<span class="sd">		&quot;&quot;&quot;</span>	
+		<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">exp</span><span class="p">(</span><span class="n">a</span> <span class="o">+</span> <span class="n">b</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">θ</span><span class="p">)</span> <span class="o">+</span> <span class="n">c</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">θ</span><span class="p">)</span><span class="o">**</span><span class="mi">2</span> <span class="o">+</span> <span class="n">d</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">θ</span><span class="p">)</span><span class="o">**</span><span class="mi">3</span><span class="p">)</span></div>
+
+	
+	<span class="k">def</span> <span class="nf">model_</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">arm_name</span><span class="p">,</span> <span class="n">n_points</span><span class="o">=</span><span class="mi">500</span><span class="p">):</span>
+		
+		<span class="n">params_</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getparams</span><span class="p">()</span>
+		<span class="n">params</span> <span class="o">=</span> <span class="n">params_</span><span class="p">[</span><span class="n">arm_name</span><span class="p">]</span>
+		
+		
+		<span class="n">θ</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">linspace</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;θ_start&#39;</span><span class="p">],</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;θ_end&#39;</span><span class="p">],</span> <span class="n">n_points</span><span class="p">)</span>
+		<span class="n">R</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">polynomial_log_spiral</span><span class="p">(</span><span class="n">θ</span><span class="p">,</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;a&#39;</span><span class="p">],</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;b&#39;</span><span class="p">],</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;c&#39;</span><span class="p">],</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;d&#39;</span><span class="p">])</span>
+				
+		<span class="c1"># Convert to Cartesian coordinates (Galactocentric)</span>
+		<span class="n">y_gc</span> <span class="o">=</span> <span class="n">R</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">cos</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">θ</span><span class="p">))</span>
+		<span class="n">x_gc</span> <span class="o">=</span> <span class="o">-</span><span class="n">R</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">sin</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">θ</span><span class="p">))</span>
+		
+		<span class="c1"># Convert to Heliocentric coordinates</span>
+		<span class="n">x_hc</span> <span class="o">=</span> <span class="p">(</span><span class="n">x_gc</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">R0</span><span class="p">)</span>
+	
+		<span class="k">return</span> <span class="n">x_hc</span><span class="p">,</span> <span class="n">y_gc</span><span class="p">,</span> <span class="n">x_gc</span><span class="p">,</span> <span class="n">y_gc</span>
+	
+<div class="viewcode-block" id="spiral_houhan.output_">
+<a class="viewcode-back" href="../../api.html#SpiralMap.models_.spiral_houhan.output_">[docs]</a>
+	<span class="k">def</span> <span class="nf">output_</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">arm</span><span class="p">):</span>			
+<span class="w">		</span><span class="sd">&quot;&quot;&quot;			</span>
+<span class="sd">		   Get arm coordinates in structured format.</span>
+<span class="sd">		</span>
+<span class="sd">		   :param arm: Arm identifier (e.g., &#39;Arm1&#39;)		</span>
+<span class="sd">		   :type arm: String </span>
+<span class="sd">		   :return: self.dout = {&#39;xhc&#39;:xhc,&#39;yhc&#39;:yhc,&#39;xgc&#39;:xgc,&#39;ygc&#39;:ygc}</span>
+<span class="sd">		   :rtype: dict </span>
+<span class="sd">		&quot;&quot;&quot;</span>				
+		
+		<span class="n">xsun</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">xsun</span>
+		<span class="bp">self</span><span class="o">.</span><span class="n">R0</span> <span class="o">=</span> <span class="o">-</span><span class="n">xsun</span>  <span class="c1"># Solar Galactocentric radius (kpc)	</span>
+		<span class="c1"># Generate spiral arm coordinates</span>
+		<span class="n">xhc</span><span class="p">,</span> <span class="n">yhc</span><span class="p">,</span> <span class="n">xgc</span><span class="p">,</span> <span class="n">ygc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">model_</span><span class="p">(</span><span class="n">arm</span><span class="p">)</span>	
+		<span class="bp">self</span><span class="o">.</span><span class="n">dout</span> <span class="o">=</span> <span class="p">{</span>
+			<span class="s1">&#39;xhc&#39;</span><span class="p">:</span> <span class="n">xhc</span><span class="p">,</span>
+			<span class="s1">&#39;yhc&#39;</span><span class="p">:</span> <span class="n">yhc</span><span class="p">,</span>
+			<span class="s1">&#39;xgc&#39;</span><span class="p">:</span> <span class="n">xgc</span><span class="p">,</span>
+			<span class="s1">&#39;ygc&#39;</span><span class="p">:</span> <span class="n">ygc</span>
+		<span class="p">}</span></div>
+</div>
+
+
+
+<div class="viewcode-block" id="spiral_houhan_HII">
+<a class="viewcode-back" href="../../api.html#SpiralMap.models_.spiral_houhan_HII">[docs]</a>
+<span class="k">class</span> <span class="nc">spiral_houhan_HII</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>	
+<span class="w">	</span><span class="sd">&quot;&quot;&quot;Hou &amp; Han (2014) polynomial-logarithmic spiral arm model, HII regions only.</span>
+<span class="sd">	</span>
+<span class="sd">	Implements the Milky Way spiral structure model from:</span>
+<span class="sd">	&quot;The spiral structure of the Milky Way from classical Cepheids&quot; (Hou &amp; Han 2014)</span>
+<span class="sd">	using polynomial-logarithmic spiral functions. Provides 6 major arm segments.	</span>
+<span class="sd">	&quot;&quot;&quot;</span>	
+	<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>			
+		<span class="bp">self</span><span class="o">.</span><span class="n">getarmlist</span><span class="p">()</span>	
+<div class="viewcode-block" id="spiral_houhan_HII.getarmlist">
+<a class="viewcode-back" href="../../api.html#SpiralMap.models_.spiral_houhan_HII.getarmlist">[docs]</a>
+	<span class="k">def</span> <span class="nf">getarmlist</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+<span class="w">		</span><span class="sd">&quot;&quot;&quot;Set arm names and colours&quot;&quot;&quot;</span>
+		<span class="bp">self</span><span class="o">.</span><span class="n">arms</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="s1">&#39;Norma&#39;</span><span class="p">,</span><span class="s1">&#39;Scutum-Centaurus&#39;</span><span class="p">,</span><span class="s1">&#39;Sagittarius-Carina&#39;</span><span class="p">,</span><span class="s1">&#39;Perseus&#39;</span><span class="p">,</span><span class="s1">&#39;Local&#39;</span><span class="p">,</span><span class="s1">&#39;Outer&#39;</span><span class="p">])</span>
+		<span class="bp">self</span><span class="o">.</span><span class="n">armcolour</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;Norma&#39;</span><span class="p">:</span><span class="s1">&#39;black&#39;</span><span class="p">,</span><span class="s1">&#39;Scutum-Centaurus&#39;</span><span class="p">:</span><span class="s1">&#39;red&#39;</span><span class="p">,</span><span class="s1">&#39;Sagittarius-Carina&#39;</span><span class="p">:</span><span class="s1">&#39;green&#39;</span><span class="p">,</span><span class="s1">&#39;Perseus&#39;</span><span class="p">:</span><span class="s1">&#39;blue&#39;</span><span class="p">,</span><span class="s1">&#39;Local&#39;</span><span class="p">:</span><span class="s1">&#39;purple&#39;</span><span class="p">,</span><span class="s1">&#39;Outer&#39;</span><span class="p">:</span><span class="s1">&#39;gold&#39;</span><span class="p">}</span>
+		<span class="bp">self</span><span class="o">.</span><span class="n">armcolours</span><span class="o">=</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">armcolour</span><span class="p">[</span><span class="n">ky</span><span class="p">]</span>  <span class="k">for</span> <span class="n">ky</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">arms</span>  <span class="p">]</span>	</div>
+
+	<span class="k">def</span> <span class="nf">info</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>		
+		<span class="n">d</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;Arm list&#39;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">arms</span><span class="p">,</span> <span class="s1">&#39;Colour&#39;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">armcolours</span><span class="p">}</span>
+		<span class="n">dfmodlist</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">(</span><span class="n">d</span><span class="p">)</span>		
+		<span class="nb">print</span><span class="p">(</span><span class="n">tabulate</span><span class="p">(</span><span class="n">dfmodlist</span><span class="p">,</span> <span class="n">headers</span> <span class="o">=</span> <span class="s1">&#39;keys&#39;</span><span class="p">,</span> <span class="n">tablefmt</span> <span class="o">=</span> <span class="s1">&#39;psql&#39;</span><span class="p">))</span>			
+		
+<div class="viewcode-block" id="spiral_houhan_HII.getparams">
+<a class="viewcode-back" href="../../api.html#SpiralMap.models_.spiral_houhan_HII.getparams">[docs]</a>
+	<span class="k">def</span> <span class="nf">getparams</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>						
+<span class="w">		</span><span class="sd">&quot;&quot;&quot;			</span>
+<span class="sd">		   Load spiral parameters from Hou &amp; Han (2014) Table 4 (vcirc=239, Z =0.16), HII regions only.</span>
+<span class="sd">		   </span>
+<span class="sd">		   :return: params ( Nested dictionary containing for each arm).</span>
+<span class="sd">		   </span>
+<span class="sd">	   				a, b, c, d: Polynomial coefficients.</span>
+<span class="sd">	   				</span>
+<span class="sd">					θ_start: Start angle in degrees (Galactic longitude).</span>
+<span class="sd">					</span>
+<span class="sd">					θ_end: End angle in degrees.		   		   </span>
+<span class="sd">		   :rtype: dict </span>
+<span class="sd">		&quot;&quot;&quot;</span>			
+
 		<span class="n">params</span> <span class="o">=</span> <span class="p">{</span>
 			<span class="s1">&#39;Norma&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;a&#39;</span><span class="p">:</span> <span class="mf">1.1668</span><span class="p">,</span> <span class="s1">&#39;b&#39;</span><span class="p">:</span> <span class="mf">0.1198</span><span class="p">,</span> <span class="s1">&#39;c&#39;</span><span class="p">:</span> <span class="mf">0.002557</span><span class="p">,</span> <span class="s1">&#39;d&#39;</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span> <span class="s1">&#39;θ_start&#39;</span><span class="p">:</span> <span class="mi">40</span><span class="p">,</span> <span class="s1">&#39;θ_end&#39;</span><span class="p">:</span> <span class="mi">250</span><span class="p">},</span>
 			<span class="s1">&#39;Scutum-Centaurus&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;a&#39;</span><span class="p">:</span> <span class="mf">5.8002</span><span class="p">,</span> <span class="s1">&#39;b&#39;</span><span class="p">:</span> <span class="o">-</span><span class="mf">1.8188</span><span class="p">,</span> <span class="s1">&#39;c&#39;</span><span class="p">:</span> <span class="mf">0.2352</span><span class="p">,</span> <span class="s1">&#39;d&#39;</span><span class="p">:</span> <span class="o">-</span><span class="mf">0.008999</span><span class="p">,</span> <span class="s1">&#39;θ_start&#39;</span><span class="p">:</span> <span class="mi">275</span><span class="p">,</span> <span class="s1">&#39;θ_end&#39;</span><span class="p">:</span> <span class="mi">620</span><span class="p">},</span>
@@ -334,10 +461,11 @@
 			<span class="s1">&#39;Local&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;a&#39;</span><span class="p">:</span> <span class="mf">0.9887</span><span class="p">,</span> <span class="s1">&#39;b&#39;</span><span class="p">:</span> <span class="mf">0.1714</span><span class="p">,</span> <span class="s1">&#39;c&#39;</span><span class="p">:</span> <span class="mf">0.004358</span><span class="p">,</span> <span class="s1">&#39;d&#39;</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span> <span class="s1">&#39;θ_start&#39;</span><span class="p">:</span> <span class="mi">280</span><span class="p">,</span> <span class="s1">&#39;θ_end&#39;</span><span class="p">:</span> <span class="mi">475</span><span class="p">},</span>
 			<span class="s1">&#39;Outer&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;a&#39;</span><span class="p">:</span> <span class="mf">3.3846</span><span class="p">,</span> <span class="s1">&#39;b&#39;</span><span class="p">:</span> <span class="o">-</span><span class="mf">0.6554</span><span class="p">,</span> <span class="s1">&#39;c&#39;</span><span class="p">:</span> <span class="mf">0.08170</span><span class="p">,</span> <span class="s1">&#39;d&#39;</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span> <span class="s1">&#39;θ_start&#39;</span><span class="p">:</span> <span class="mi">280</span><span class="p">,</span> <span class="s1">&#39;θ_end&#39;</span><span class="p">:</span> <span class="mi">355</span><span class="p">}</span>
 		<span class="p">}</span>	
+
 		<span class="k">return</span> <span class="n">params</span>		</div>
 
-<div class="viewcode-block" id="spiral_houhan.polynomial_log_spiral">
-<a class="viewcode-back" href="../../api.html#SpiralMap.models_.spiral_houhan.polynomial_log_spiral">[docs]</a>
+<div class="viewcode-block" id="spiral_houhan_HII.polynomial_log_spiral">
+<a class="viewcode-back" href="../../api.html#SpiralMap.models_.spiral_houhan_HII.polynomial_log_spiral">[docs]</a>
 	<span class="k">def</span> <span class="nf">polynomial_log_spiral</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">θ</span><span class="p">,</span> <span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">c</span><span class="p">,</span> <span class="n">d</span><span class="p">):</span>		
 <span class="w">		</span><span class="sd">&quot;&quot;&quot;Calculate radius using polynomial-logarithmic spiral equation.</span>
 <span class="sd">		</span>
@@ -372,16 +500,16 @@
 		<span class="n">R</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">polynomial_log_spiral</span><span class="p">(</span><span class="n">θ</span><span class="p">,</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;a&#39;</span><span class="p">],</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;b&#39;</span><span class="p">],</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;c&#39;</span><span class="p">],</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;d&#39;</span><span class="p">])</span>
 		
 		<span class="c1"># Convert to Cartesian coordinates (Galactocentric)</span>
-		<span class="n">x_gc</span> <span class="o">=</span> <span class="n">R</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">cos</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">θ</span><span class="p">))</span>
-		<span class="n">y_gc</span> <span class="o">=</span> <span class="n">R</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">sin</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">θ</span><span class="p">))</span>
+		<span class="n">y_gc</span> <span class="o">=</span> <span class="n">R</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">cos</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">θ</span><span class="p">))</span>
+		<span class="n">x_gc</span> <span class="o">=</span> <span class="o">-</span><span class="n">R</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">sin</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">radians</span><span class="p">(</span><span class="n">θ</span><span class="p">))</span>
 		
 		<span class="c1"># Convert to Heliocentric coordinates</span>
 		<span class="n">x_hc</span> <span class="o">=</span> <span class="p">(</span><span class="n">x_gc</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">R0</span><span class="p">)</span>
 	
 		<span class="k">return</span> <span class="n">x_hc</span><span class="p">,</span> <span class="n">y_gc</span><span class="p">,</span> <span class="n">x_gc</span><span class="p">,</span> <span class="n">y_gc</span>
 	
-<div class="viewcode-block" id="spiral_houhan.output_">
-<a class="viewcode-back" href="../../api.html#SpiralMap.models_.spiral_houhan.output_">[docs]</a>
+<div class="viewcode-block" id="spiral_houhan_HII.output_">
+<a class="viewcode-back" href="../../api.html#SpiralMap.models_.spiral_houhan_HII.output_">[docs]</a>
 	<span class="k">def</span> <span class="nf">output_</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">arm</span><span class="p">):</span>			
 <span class="w">		</span><span class="sd">&quot;&quot;&quot;			</span>
 <span class="sd">		   Get arm coordinates in structured format.</span>
@@ -406,6 +534,8 @@
 
 
 
+
+
 <div class="viewcode-block" id="spiral_levine">
 <a class="viewcode-back" href="../../api.html#SpiralMap.models_.spiral_levine">[docs]</a>
 <span class="k">class</span> <span class="nc">spiral_levine</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>		
@@ -969,7 +1099,7 @@
 <span class="sd">		&quot;&quot;&quot;</span>	
 		   		
 		<span class="bp">self</span><span class="o">.</span><span class="n">models</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;Taylor_Cordes_1992&#39;</span><span class="p">,</span><span class="s1">&#39;Drimmel_NIR_2000&#39;</span><span class="p">,</span>
-					   <span class="s1">&#39;Levine_2006&#39;</span><span class="p">,</span><span class="s1">&#39;Hou_Han_2014&#39;</span><span class="p">,</span><span class="s1">&#39;Reid_2019&#39;</span><span class="p">,</span>
+					   <span class="s1">&#39;Levine_2006&#39;</span><span class="p">,</span><span class="s1">&#39;Hou_Han_2014&#39;</span><span class="p">,</span><span class="s1">&#39;Hou_Han_HII_2014&#39;</span><span class="p">,</span><span class="s1">&#39;Reid_2019&#39;</span><span class="p">,</span>
 					   <span class="s1">&#39;Poggio_cont_2021&#39;</span><span class="p">,</span><span class="s1">&#39;GaiaPVP_cont_2022&#39;</span><span class="p">,</span><span class="s1">&#39;Drimmel_Ceph_2024&#39;</span><span class="p">]</span>        
 		<span class="bp">self</span><span class="o">.</span><span class="n">models_class</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;Reid_2019&#39;</span><span class="p">:</span><span class="n">reid_spiral</span><span class="p">(),</span>
 							 <span class="s1">&#39;Levine_2006&#39;</span><span class="p">:</span><span class="n">spiral_levine</span><span class="p">(),</span>
@@ -978,10 +1108,11 @@
 							 <span class="s1">&#39;Drimmel_NIR_2000&#39;</span><span class="p">:</span><span class="n">spiral_drimmel_nir</span><span class="p">(),</span>
 							 <span class="s1">&#39;Taylor_Cordes_1992&#39;</span><span class="p">:</span><span class="n">TaylorCordesSpiral</span><span class="p">(),</span>
 							 <span class="s1">&#39;Hou_Han_2014&#39;</span><span class="p">:</span><span class="n">spiral_houhan</span><span class="p">(),</span>
+							 <span class="s1">&#39;Hou_Han_HII_2014&#39;</span><span class="p">:</span><span class="n">spiral_houhan_HII</span><span class="p">(),</span>
 							 <span class="s1">&#39;Drimmel_Ceph_2024&#39;</span><span class="p">:</span><span class="n">spiral_drimmel_cepheids</span><span class="p">()}</span>
 							 
 		<span class="bp">self</span><span class="o">.</span><span class="n">models_desc</span> <span class="o">=</span> 	<span class="p">[</span><span class="s1">&#39;HII&#39;</span><span class="p">,</span><span class="s1">&#39;NIR emission&#39;</span><span class="p">,</span>
-					   <span class="s1">&#39;HI&#39;</span><span class="p">,</span><span class="s1">&#39;HII/GMC/Masers&#39;</span><span class="p">,</span><span class="s1">&#39;MASER parallax&#39;</span><span class="p">,</span>
+					   <span class="s1">&#39;HI&#39;</span><span class="p">,</span><span class="s1">&#39;HII/GMC/Masers&#39;</span><span class="p">,</span><span class="s1">&#39;HII&#39;</span><span class="p">,</span><span class="s1">&#39;MASER parallax&#39;</span><span class="p">,</span>
 					   <span class="s1">&#39;Upper main sequence (map)&#39;</span><span class="p">,</span><span class="s1">&#39;OB stars (map)&#39;</span><span class="p">,</span><span class="s1">&#39;Cepheids&#39;</span><span class="p">]</span>  			 							 </div>
 
 <div class="viewcode-block" id="main_.getinfo">
@@ -1132,7 +1263,7 @@
 	
 	<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 					
-		<span class="bp">self</span><span class="o">.</span><span class="n">xsun</span> <span class="o">=</span> <span class="o">-</span><span class="mf">8.277</span>	
+		<span class="bp">self</span><span class="o">.</span><span class="n">Rsun</span> <span class="o">=</span> <span class="mf">8.277</span>	
 	
 		<span class="c1"># self.prep_poggio_polar()</span>
 		<span class="bp">self</span><span class="o">.</span><span class="n">savelims_all</span><span class="p">()</span>
@@ -1150,7 +1281,7 @@
 			<span class="n">plt</span><span class="o">.</span><span class="n">close</span><span class="p">(</span><span class="s1">&#39;all&#39;</span><span class="p">)</span>
 			<span class="n">plotattrs</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;plot&#39;</span><span class="p">:</span><span class="kc">True</span><span class="p">,</span><span class="s1">&#39;coordsys&#39;</span><span class="p">:</span> <span class="s1">&#39;HC&#39;</span><span class="p">,</span><span class="s1">&#39;markersize&#39;</span><span class="p">:</span><span class="mi">15</span><span class="p">,</span><span class="s1">&#39;linewidth&#39;</span><span class="p">:</span><span class="mi">1</span><span class="p">,</span><span class="s1">&#39;polarproj&#39;</span><span class="p">:</span><span class="kc">False</span><span class="p">,</span><span class="s1">&#39;armcolour&#39;</span><span class="p">:</span><span class="s1">&#39;black&#39;</span><span class="p">}</span>	
 			<span class="n">sp</span> <span class="o">=</span> <span class="n">spiral_poggio_maps</span><span class="p">(</span><span class="n">model_</span><span class="o">=</span><span class="n">usemodel</span><span class="p">)</span>
-			<span class="n">sp</span><span class="o">.</span><span class="n">xsun</span> <span class="o">=</span> <span class="n">xsun</span>
+			<span class="n">sp</span><span class="o">.</span><span class="n">Rsun</span> <span class="o">=</span> <span class="n">Rsun</span>
 			<span class="n">cset1</span><span class="p">,</span><span class="n">cset2</span> <span class="o">=</span> <span class="n">sp</span><span class="o">.</span><span class="n">output_</span><span class="p">(</span><span class="n">plotattrs</span><span class="p">)</span>
 			
 			<span class="c1"># # check xy projection</span>
@@ -1202,11 +1333,11 @@
 	<span class="k">def</span> <span class="nf">savelims_all</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>		
 	
 		<span class="nb">print</span><span class="p">(</span><span class="s1">&#39;saving plot limits for all models&#39;</span><span class="p">)</span>
-		<span class="n">xsun</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">xsun</span>
+		<span class="n">Rsun</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">Rsun</span>
 	
 		<span class="n">mylims</span> <span class="o">=</span> <span class="p">{}</span>
 		
-		<span class="n">spirals</span> <span class="o">=</span> <span class="n">main_</span><span class="p">(</span><span class="n">xsun</span><span class="o">=</span><span class="n">xsun</span><span class="p">)</span>
+		<span class="n">spirals</span> <span class="o">=</span> <span class="n">main_</span><span class="p">(</span><span class="n">Rsun</span><span class="o">=</span><span class="n">Rsun</span><span class="p">)</span>
 		<span class="k">for</span> <span class="n">inum</span><span class="p">,</span><span class="n">use_model</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">spirals</span><span class="o">.</span><span class="n">models</span><span class="p">):</span>				
 			
 			<span class="n">plt</span><span class="o">.</span><span class="n">close</span><span class="p">(</span><span class="s1">&#39;all&#39;</span><span class="p">)</span>
@@ -1239,11 +1370,11 @@
 	<span class="k">def</span> <span class="nf">savelims</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>		
 	
 		<span class="nb">print</span><span class="p">(</span><span class="s1">&#39;saving plot limits for all models&#39;</span><span class="p">)</span>
-		<span class="n">xsun</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">xsun</span>
+		<span class="n">Rsun</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">Rsun</span>
 	
 		<span class="n">mylims</span> <span class="o">=</span> <span class="p">{}</span>
 		
-		<span class="n">spirals</span> <span class="o">=</span> <span class="n">main_</span><span class="p">(</span><span class="n">xsun</span><span class="o">=</span><span class="n">xsun</span><span class="p">)</span>
+		<span class="n">spirals</span> <span class="o">=</span> <span class="n">main_</span><span class="p">(</span><span class="n">Rsun</span><span class="o">=</span><span class="n">Rsun</span><span class="p">)</span>
 		
 		<span class="k">for</span> <span class="n">inum</span><span class="p">,</span><span class="n">use_model</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">spirals</span><span class="o">.</span><span class="n">models</span><span class="p">):</span>	
 						
@@ -1284,6 +1415,7 @@
 	
 
 
+<span class="c1"># # _make_supportfiles()</span>
 </pre></div>
 
            </div>
@@ -1293,7 +1425,7 @@
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2025, Prusty &amp; Khanna.</p>
+    <p>&#169; Copyright 2025, Abhay Kumar Prusty &amp; Shourya Khanna.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

{spiralmap-0.0.12 → spiralmap-0.0.21}/docs/build/html/_modules/index.html

@@ -16,6 +16,13 @@
       <script src="../_static/documentation_options.js?v=f2a433a1"></script>
       <script src="../_static/doctools.js?v=9a2dae69"></script>
       <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+      <script src="https://www.googletagmanager.com/gtag/js?id=G-2D1BGW81C9"></script>
+      <script>
+        window.dataLayer = window.dataLayer || [];
+        function gtag(){dataLayer.push(arguments);}
+        gtag('js', new Date());
+        gtag('config', 'G-2D1BGW81C9');
+    </script>
     <script src="../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" /> 
@@ -82,7 +89,7 @@
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2025, Prusty &amp; Khanna.</p>
+    <p>&#169; Copyright 2025, Abhay Kumar Prusty &amp; Shourya Khanna.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

{spiralmap-0.0.12/docs → spiralmap-0.0.21/docs/build}/html/_sources/index.rst.txt

@@ -17,7 +17,7 @@ To this end, with `SpiralMap` one can:
 + Directly overplot spiral arms with choice of Cartesian or Polar coordinates, and in Heliocentric or Galactocentric frames.
 
 
-For a quick demonstration please see the accompanying `Jupyter Notebook <https://github.com/Abhaypru/SpiralMap/blob/main/demo_spiralmap.ipynb>`_. here
+For a quick demonstration please see the accompanying `Jupyter Notebook <https://github.com/Abhaypru/SpiralMap/blob/main/demo_spiralmap.ipynb>`_.
 
 
 .. figure:: ../../src/SpiralMap/movie_.gif
@@ -25,7 +25,8 @@ For a quick demonstration please see the accompanying `Jupyter Notebook <https:/
    A gallery of the various models included in this version, in this case in polar projection and in Galactocentric coordinates with 
    the locations of the Sun and the Galactic center (star) marked.
    
-   
+
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:

{spiralmap-0.0.12/docs → spiralmap-0.0.21/docs/build}/html/_sources/install.rst.txt

@@ -1,7 +1,7 @@
 Installation 
 =============
 
-The **SpiralMap** package is available through  `PyPI <https://test.pypi.org/project/SpiralMap/>`_ and `GitHub <https://github.com/Abhaypru/SpiralMap>`_ .
+The **SpiralMap** package is available through  `PyPI <https://pypi.org/project/SpiralMap/>`_ and `GitHub <https://github.com/Abhaypru/SpiralMap>`_ .
 To install SpiralMap with pip from PyPI, run:
 
 .. code-block:: bash