docs: fix

Author: Beforerr

Project.toml

@@ -7,8 +7,10 @@ authors = ["Beforerr <zzj956959688@gmail.com> and contributors"]
 projects = ["test", "docs"]
 
 [deps]
+Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
 PythonCall = "6099a3de-0909-46bc-b1f4-468b9a2dfc0d"
 
 [compat]
+Aqua = "0.8.14"
 PythonCall = "0.9"
 julia = "1.10"

README.md

@@ -1,9 +1,11 @@
 # SunPy
 
-[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaSpacePhysics.github.io/SunPy.jl/stable/)
-[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaSpacePhysics.github.io/SunPy.jl/dev/)
 [![Build Status](https://github.com/JuliaSpacePhysics/SunPy.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/JuliaSpacePhysics/SunPy.jl/actions/workflows/CI.yml?query=branch%3Amain)
 [![Coverage](https://codecov.io/gh/JuliaSpacePhysics/SunPy.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/JuliaSpacePhysics/SunPy.jl)
 [![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
 
-A Julia wrapper around [SunPy](https://github.com/sunpy/sunpy)
+A Julia wrapper around [SunPy](https://github.com/sunpy/sunpy)
+
+**Installation**: at the Julia REPL, run `using Pkg; Pkg.add("https://github.com/JuliaSpacePhysics/SunPy.jl")`
+
+**Documentation**: [![Dev](https://img.shields.io/badge/docs-dev-blue.svg?logo=julia)](https://JuliaSpacePhysics.github.io/SunPy.jl/dev/)

docs/make.jl

@@ -1,7 +1,13 @@
 using SunPy
 using Documenter
+using PythonCall
 
-DocMeta.setdocmeta!(SunPy, :DocTestSetup, :(using SunPy); recursive = true)
+DocMeta.setdocmeta!(SunPy, :DocTestSetup, :(using SunPy))
+
+# Download data first to render the documentation
+# Without `sunpy.data.sample.AIA_171_IMAGE` the CI stuck
+pyimport("sunpy.data.sample")
+sunpy.data.sample.AIA_171_IMAGE
 
 makedocs(;
     modules = [SunPy],

docs/src/index.md

@@ -1,7 +1,3 @@
-```@meta
-CurrentModule = SunPy
-```
-
 # SunPy
 
 Documentation for [SunPy](https://github.com/JuliaSpacePhysics/SunPy.jl).
@@ -13,9 +9,9 @@ Documentation for [SunPy](https://github.com/JuliaSpacePhysics/SunPy.jl).
 Modules = [SunPy]
 ```
 
-## Quickstart
+## Acquiring Data
 
-Using the [`Fido`](https://docs.sunpy.org/en/stable/generated/api/sunpy.net.Fido.html) interface (a unified data search and retrieval tool) to obtain solar data. 
+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
 using SunPy, PythonCall
@@ -24,13 +20,12 @@ Fido
 Fido.search(a.Time("2012/3/4", "2012/3/6"), a.Instrument.lyra, a.Level.two)
 ```
 
-`Map` object in sunpy.
+## Maps
 
-<!-- https://docs.sunpy.org/en/stable/tutorial/maps.html -->
+`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)
-# my_map.quicklook()
 ```

src/types.jl

@@ -12,3 +12,17 @@ PythonCall.Py(mod::PythonModule) = getfield(mod, :mod)
     name in m.autoimports && return pyimport("$(py.__name__).$name")
     return getproperty(py, name)
 end
+
+struct Map{T, N, A <: AbstractArray{T, N}} <: AbstractArray{T, N}
+    py::Py
+    data::A
+end
+
+Base.size(m::Map) = Base.size(m.data)
+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))
+end

test/runtests.jl

@@ -7,3 +7,12 @@ using Aqua
 end
 
 include("fido.jl")
+
+@testset "Maps" begin
+    using PythonCall
+    pyimport("sunpy.data.sample")
+    m = SunPy.Map(sunpy.data.sample.AIA_171_IMAGE)
+    @test m isa AbstractArray
+    @test size(m) == (1024, 1024)
+    @test m[1] == -95.92475f0
+end