feat: offset Map

docs: add example of "Finding the brightest pixel"

Author: Beforerr

Project.toml

@@ -7,8 +7,10 @@ authors = ["Beforerr <zzj956959688@gmail.com> and contributors"]
 projects = ["test", "docs"]
 
 [deps]
+OffsetArrays = "6fe1bfb0-de20-5000-8ca7-80f57d26f881"
 PythonCall = "6099a3de-0909-46bc-b1f4-468b9a2dfc0d"
 
 [compat]
+OffsetArrays = "1"
 PythonCall = "0.9"
 julia = "1.10"

docs/Project.toml

@@ -1,4 +1,5 @@
 [deps]
+Chairmarks = "0ca39b1e-fe0b-4e98-acfc-b1656634c4de"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 PythonCall = "6099a3de-0909-46bc-b1f4-468b9a2dfc0d"
 SunPy = "d53ba2b8-6a4a-4633-896a-a050af4da271"

docs/make.jl

@@ -22,6 +22,9 @@ makedocs(;
         "Tutorials" => [
             "Coordinates" => "tutorials/coordinates.md",
         ],
+        "Example Gallery" => [
+            "gallery/brightness_pixel_location.md",
+        ],
     ],
 )
 

docs/src/gallery/brightness_pixel_location.md

@@ -0,0 +1,37 @@
+# Finding the brightest pixel
+
+Reference: corresponding [sunpy webpage](https://docs.sunpy.org/en/stable/generated/gallery/map/brightness_pixel_location.html).
+
+```@example pixel
+using SunPy, PythonCall
+using SunPy: Map
+@py import sunpy.data.sample: AIA_171_IMAGE
+@py import astropy.units as u
+
+aia = Map(AIA_171_IMAGE)
+pixel_pos = Tuple(argmax(aia')) .* u.pixel
+hpc_max = aia.wcs.pixel_to_world(pixel_pos...)
+```
+
+Let’s now plot the results.
+
+```@example pixel
+@py import matplotlib.pyplot as plt
+
+fig = plt.figure()
+ax = fig.add_subplot(projection=aia)
+aia.plot(axes=ax)
+ax.plot_coord(hpc_max, "wx", fillstyle="none", markersize=10)
+fig
+```
+
+
+## Acceleration
+
+```@repl pixel
+using Chairmarks
+@py import numpy as np
+
+@b sunpy.map.Map(AIA_171_IMAGE) @py(np.argwhere(_.data == _.data.max()))
+@b Map(AIA_171_IMAGE) argmax(_)
+```

docs/src/index.md

@@ -1,6 +1,13 @@
 # SunPy
 
-Documentation for [SunPy](https://github.com/JuliaSpacePhysics/SunPy.jl).
+A Julia wrapper around [SunPy](https://www.sunpy.org).
+
+## Motivation
+
+This package brings SunPy's solar physics capabilities to Julia, enabling:
+
+- **Performant Array manipulation**: Leverage Julia's powerful and flexible array manipulation for accelerated numerical computations
+- **Ecosystem integration**: Combine solar data analysis with the broader Julia scientific computing stack (e.g., [SciML](https://sciml.ai/), [JuliaAstro](https://juliaastro.org/home/))
 
 ```@index
 ```
@@ -13,7 +20,7 @@ Modules = [SunPy]
 
 Obtaining solar data using the [`Fido`](https://docs.sunpy.org/en/stable/generated/api/sunpy.net.Fido.html) interface (a unified data search and retrieval tool). 
 
-```@example sunpy
+```@repl sunpy
 using SunPy, PythonCall
 @py import sunpy.net: Fido, attrs as a
 Fido
@@ -25,7 +32,6 @@ Fido.search(a.Time("2012/3/4", "2012/3/6"), a.Instrument.lyra, a.Level.two)
 `Map` object in [sunpy](https://docs.sunpy.org/en/stable/tutorial/maps.html).
 
 ```@example sunpy
-pyimport("sunpy.data.sample")
-sunpy.data.sample.AIA_171_IMAGE
-my_map = sunpy.map.Map(sunpy.data.sample.AIA_171_IMAGE)
+@py import sunpy.data.sample: AIA_171_IMAGE
+my_map = sunpy.map.Map(AIA_171_IMAGE)
 ```

src/SunPy.jl

@@ -1,6 +1,8 @@
 module SunPy
 
 using PythonCall
+using OffsetArrays
+using OffsetArrays: Origin
 
 export sunpy
 

src/types.jl

@@ -18,11 +18,18 @@ struct Map{T, N, A <: AbstractArray{T, N}} <: AbstractArray{T, N}
     data::A
 end
 
-Base.size(m::Map) = Base.size(m.data)
+for f in (:size, :axes)
+    @eval Base.$f(m::Map) = Base.$f(m.data)
+end
+
 Base.getindex(m::Map, args...) = Base.getindex(m.data, args...)
 Base.show(io::IO, m::MIME"text/plain", map::Map) = Base.show(io, m, map.py)
 
 function Map(path)
-    py = sunpy.map.Map(path)
-    return Map(py, PyArray(py.data; copy = false))
+    py = (@pyconst sunpy.map.Map)(path)
+    pyarr = PyArray(@py py.data; copy = false)
+    return Map(py, Origin(0)(pyarr))
 end
+
+@inline Base.getproperty(m::Map, s::Symbol) =
+    s in fieldnames(Map) ? getfield(m, s) : getproperty(m.py, s)