diff --git a/README.md b/README.md index 5d886b80e8..2126c7cdc9 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ PairPlots.jl: ``` > [!NOTE] -> The overall `ecosystem` object that this entry is stored in determines the order of the top level dropdown menus on the site (`highlevel`) and how each package appears on both pages, alphabetically by package name (`name`). Packages under the JuliaAstro organization are listed as their bare name, while packages outside of the organization have their parent repo name prepended to it, e.g., `sefffal/PairPlots.jl` +> The overall `ecosystem` object that this entry is stored in determines the order of the top level dropdown menus on the site (`highlevel`) and how each package appears on both pages, alphabetically by package name (`name`). Entries are keyed by their bare package name (e.g., `PairPlots.jl`). Packages outside of the JuliaAstro organization are automatically displayed with their GitHub org prepended to the name based on their `repo` field, e.g., `sefffal/PairPlots.jl` If appropriate, we appreciate a quick entry for your package in the `astropy` field that relates it to a similar package in the [Astropy ecosystem](https://www.astropy.org/). This helps new users who may be more familiar with Python get more easily oriented in the Julia ecosystem. See our [Comparison page](https://juliaastro.org/home/comparison/) for examples. If you feel that there is not a good match for your package, you can just leave the `astropy` field blank (i.e., as an empty array `[]`) and it will not appear in this page. diff --git a/docs/case_studies/solar_system/amazonia.md b/docs/case_studies/solar_system/amazonia.md index 94b11db910..5801770cd1 100644 --- a/docs/case_studies/solar_system/amazonia.md +++ b/docs/case_studies/solar_system/amazonia.md @@ -5,7 +5,7 @@ author: "[Ronan Arraes Jardim Chagas](https://github.com/ronisbr)" date: "2021-03-19" --- -The [Brazilian National Institute for Space Research (INPE)](https://www.gov.br/inpe/) uses [SatelliteToolbox.jl](https://github.com/JuliaSpace/SatelliteToolbox.jl) to plan its current and future Earth satellite missions. +The [Brazilian National Institute for Space Research (INPE)](https://www.gov.br/inpe/) uses [JuliaSpace/SatelliteToolbox.jl](https://github.com/JuliaSpace/SatelliteToolbox.jl) to plan its current and future Earth satellite missions. ![image](https://global.discourse-cdn.com/julialang/original/3X/e/5/e59846ff7eaf27725ccb8f0555b7c7e8600a32c0.jpeg) diff --git a/docs/case_studies/stars_and_galaxies/ptiede-polarization.md b/docs/case_studies/stars_and_galaxies/ptiede-polarization.md index 8b88cab9e5..d50475149b 100644 --- a/docs/case_studies/stars_and_galaxies/ptiede-polarization.md +++ b/docs/case_studies/stars_and_galaxies/ptiede-polarization.md @@ -6,7 +6,7 @@ author: "[Paul Tiede](https://github.com/ptiede); [Kazu Akiyama](https://github. date: 2025-09-04 --- -A new result from the team behind [Comrade.jl](@ref) at the [Event Horizon Telescope (EHT) collaboration](https://eventhorizontelescope.org/) has discovered an unexpected flip in the measured polarization of the magnetic fields around the supermassive black hole, M87*. Using Julia, this team was able to detect the magnetic spirals first spiraling one way in 2017, settling in 2018, and then reversing direction in 2021, indicating a dynamic environment with changing polarization patterns. +A new result from the team behind [ptiede/Comrade.jl](@ref) at the [Event Horizon Telescope (EHT) collaboration](https://eventhorizontelescope.org/) has discovered an unexpected flip in the measured polarization of the magnetic fields around the supermassive black hole, M87*. Using Julia, this team was able to detect the magnetic spirals first spiraling one way in 2017, settling in 2018, and then reversing direction in 2021, indicating a dynamic environment with changing polarization patterns. **Package: [ptiede/Comrade.jl](https://github.com/ptiede/Comrade.jl)** diff --git a/docs/make.jl b/docs/make.jl index ea53361a86..770df540b3 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -124,10 +124,11 @@ end function generate_multidoc_refs((name, p); clonedir=clonedir) package_path = string(chopsuffix(name, ".jl")) - package_name = if package_path in wrapper_packages - "◯ " * package_path + package_label = chopsuffix(JuliaAstroDocs.display_name(name, p), ".jl") + package_name = if package_label in wrapper_packages + "◯ " * package_label else - "⬤ " * package_path + "⬤ " * package_label end multidoc_type = if any(occursin.(("stable", "dev"), p["doc"])) && startswith(p["doc"], "https://juliaastro") "MultiDocRef" diff --git a/src/comparison.jl b/src/comparison.jl index 8405734a96..deb2a1637a 100644 --- a/src/comparison.jl +++ b/src/comparison.jl @@ -2,7 +2,7 @@ stake! = String ∘ take! package_row((name, p)) = """ - $(name) + $(display_name(name, p)) $(p["tagline"]) """ diff --git a/src/ecosystem.jl b/src/ecosystem.jl index 471e7ed845..9adf63ae1f 100644 --- a/src/ecosystem.jl +++ b/src/ecosystem.jl @@ -7,6 +7,17 @@ The joy of our community is the many astronomy and astrophysics packages availab """; +# Prefix packages outside of JuliaAstro with their org, e.g., JuliaSpace/SatelliteToolbox.jl +function display_name(name, p) + url_parts = split(p["repo"], '/') + org_name = url_parts[4] + # Org-level entries (e.g., https://github.com/JuliaStats) are left as is + if lowercase(org_name) == "juliaastro" || length(url_parts) < 5 + return name + end + return string(org_name, '/', name) +end + function page_ecosystem(ecosystem) fpath = joinpath(dirname(@__DIR__), "docs", "src", "ecosystem.md") open(fpath, "w") do io @@ -16,11 +27,9 @@ function page_ecosystem(ecosystem) for (sublevel, packages) in sublevels write(io, "### ", sublevel, "\n\n") for (name, p) in packages - org_name = split(p["repo"], '/')[4] - write(io, "#### ", name, "\n\n") + write(io, "#### ", display_name(name, p), "\n\n") write(io, "[💻 Repository](", p["repo"], ") | ") - write(io, "[📘 Documentation](", p["doc"], ")") - write(io, " | `", org_name, "`\n\n") + write(io, "[📘 Documentation](", p["doc"], ")\n\n") write(io, "**", p["tagline"], "**", "\n\n") write(io, p["descr"], "\n\n") end