feat: init wrapping

Author: Beforerr

.github/workflows/Doc.yml

@@ -0,0 +1,36 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "src/**"
+      - "docs/**"
+      - "Project.toml"
+      - "docs/Project.toml"
+    tags: ["*"]
+  pull_request:
+    paths:
+      - "src/**"
+      - "docs/**"
+      - "Project.toml"
+      - "docs/Project.toml"
+  workflow_dispatch:
+
+concurrency:
+  # Skip intermediate builds: always.
+  # Cancel intermediate builds: only if it is a pull request build.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+
+jobs:
+  docs:
+    permissions:
+      actions: write # needed to allow julia-actions/cache to proactively delete old caches that it has created
+      contents: write
+      statuses: write
+    runs-on: ubuntu-latest
+    steps:
+      - name: Build and deploy Documenter.jl docs
+        uses: JuliaSpacePhysics/actions/DocsDocumenter@main

.gitignore

@@ -4,3 +4,4 @@
 /Manifest*.toml
 /docs/Manifest*.toml
 /docs/build/
+.CondaPkg

CondaPkg.toml

@@ -0,0 +1,3 @@
+[deps]
+sunpy = ""
+certifi = ""

Project.toml

@@ -1,7 +1,14 @@
 name = "SunPy"
 uuid = "d53ba2b8-6a4a-4633-896a-a050af4da271"
-authors = ["Beforerr <zzj956959688@gmail.com> and contributors"]
 version = "1.0.0-DEV"
+authors = ["Beforerr <zzj956959688@gmail.com> and contributors"]
+
+[workspace]
+projects = ["test", "docs"]
+
+[deps]
+PythonCall = "6099a3de-0909-46bc-b1f4-468b9a2dfc0d"
 
 [compat]
+PythonCall = "0.9"
 julia = "1.10"

README.md

@@ -5,3 +5,5 @@
 [![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)

docs/Project.toml

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

docs/make.jl

@@ -1,23 +1,24 @@
 using SunPy
 using Documenter
 
-DocMeta.setdocmeta!(SunPy, :DocTestSetup, :(using SunPy); recursive=true)
+DocMeta.setdocmeta!(SunPy, :DocTestSetup, :(using SunPy); recursive = true)
 
 makedocs(;
-    modules=[SunPy],
-    authors="Beforerr <zzj956959688@gmail.com> and contributors",
-    sitename="SunPy.jl",
-    format=Documenter.HTML(;
-        canonical="https://JuliaSpacePhysics.github.io/SunPy.jl",
-        edit_link="main",
-        assets=String[],
+    modules = [SunPy],
+    authors = "Beforerr <zzj956959688@gmail.com> and contributors",
+    sitename = "SunPy.jl",
+    format = Documenter.HTML(;
+        canonical = "https://JuliaSpacePhysics.github.io/SunPy.jl",
     ),
-    pages=[
+    pages = [
         "Home" => "index.md",
+        "Tutorials" => [
+            "Coordinates" => "tutorials/coordinates.md",
+        ],
     ],
 )
 
 deploydocs(;
-    repo="github.com/JuliaSpacePhysics/SunPy.jl",
-    devbranch="main",
+    repo = "github.com/JuliaSpacePhysics/SunPy.jl",
+    push_preview = true
 )

docs/src/index.md

@@ -12,3 +12,23 @@ Documentation for [SunPy](https://github.com/JuliaSpacePhysics/SunPy.jl).
 ```@autodocs
 Modules = [SunPy]
 ```
+
+## Quickstart
+
+using the `Fido` interface to obtain solar data. 
+
+```@example sunpy
+using SunPy, PythonCall
+@py import sunpy.net: Fido, attrs as a
+Fido
+Fido.search(a.Time("2012/3/4", "2012/3/6"), a.Instrument.lyra, a.Level.two)
+```
+
+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()
+```

docs/src/tutorials/coordinates.md

@@ -0,0 +1,41 @@
+# Coordinates
+
+This section of the guide introduces how coordinates are represented in sunpy.
+
+Corresponding sunpy tutorial: https://docs.sunpy.org/en/stable/tutorial/coordinates.html#
+
+```@example sunpy
+using SunPy
+using SunPy: SkyCoord
+using PythonCall
+@py import astropy.units as u
+@py import sunpy.coordinates.frames as frames
+```
+
+```@example sunpy
+@py coord = SkyCoord(70*u.deg, -30*u.deg, obstime="2017-08-01",
+                 frame=frames.HeliographicStonyhurst)
+```
+
+```@example sunpy
+coord.transform_to(frames.Helioprojective(observer="earth"))
+```
+
+```@example sunpy
+@py import sunpy.data.sample: AIA_171_IMAGE 
+@py import matplotlib.pyplot as plt
+
+amap = sunpy.map.Map(AIA_171_IMAGE)
+coord = SkyCoord(100 * u.arcsec, 10*u.arcsec, frame=amap.coordinate_frame)
+pixels = amap.wcs.world_to_pixel(coord)
+```
+
+```@example sunpy
+fig = plt.figure()
+ax = plt.subplot(projection=amap)
+amap.plot()
+ax.plot_coord(coord, 'o')
+fig
+```
+
+

src/SunPy.jl

@@ -1,5 +1,24 @@
 module SunPy
 
-# Write your package code here.
+using PythonCall
 
+export sunpy
+
+include("types.jl")
+
+const sunpy = PythonModule(PythonCall.pynew(), (:data, :map, :net, :visualization))
+const astropy = PythonModule(PythonCall.pynew())
+
+function __init__()
+    certifi = pyimport("certifi")
+    ENV["SSL_CERT_FILE"] = pyconvert(String, certifi.where())
+
+    PythonCall.pycopy!(sunpy.mod, pyimport("sunpy"))
+    PythonCall.pycopy!(astropy.mod, pyimport("astropy"))
+    return
+end
+
+function SkyCoord(args...; kw...)
+    return (@pyconst pyimport("astropy.coordinates").SkyCoord)(args...; kw...)
+end
 end