Merge pull request #232 from JuliaAstro/updates

Updates

Author: barrettp

.github/workflows/CI.yml

@@ -20,19 +20,16 @@ jobs:
       fail-fast: false
       matrix:
         version:
-          - "1.3"
+          - "min"
           - "1"
-          - "nightly"
+          - "pre"
         os:
           - ubuntu-latest
           - macOS-latest
           - macOS-13
           - windows-latest
         arch:
           - default
-        exclude:
-          - os: macOS-latest
-            version: "1.3"
     steps:
       - uses: actions/checkout@v6
       - uses: julia-actions/setup-julia@v2
@@ -42,24 +39,11 @@ jobs:
       - uses: julia-actions/cache@v2
       - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-runtest@v1
+        with:
+          test_args: "--verbose"
       - uses: julia-actions/julia-processcoverage@v1
       - uses: codecov/codecov-action@v5
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           files: lcov.info
         continue-on-error: true
-
-  docs:
-    name: Documentation
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v6
-      - uses: julia-actions/setup-julia@v2
-        with:
-          version: "1"
-      - uses: julia-actions/cache@v2
-      - uses: julia-actions/julia-docdeploy@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
-          JULIA_PKG_SERVER: ""

.github/workflows/Documentation.yml

@@ -0,0 +1,29 @@
+name: Documentation
+
+on:
+  push:
+    branches: [master]
+    tags: ["*"]
+  pull_request:
+
+concurrency:
+  # Skip intermediate builds: always.
+  # Cancel intermediate builds: always.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  docs:
+    name: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: "1"
+      - uses: julia-actions/cache@v2
+      - uses: julia-actions/julia-docdeploy@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
+          JULIA_PKG_SERVER: ""

NEWS.md

@@ -2,11 +2,12 @@ name = "FITSIO"
 uuid = "525bcba6-941b-5504-bd06-fd0dc1a4d2eb"
 version = "0.17.5"
 
+[workspace]
+projects = ["test", "docs"]
+
 [deps]
 CFITSIO = "3b1b4be9-1499-4b22-8d78-7db3344d1961"
 Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
-Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
-Tables = "bd369af6-aec1-5ad0-b16a-f7cc5008161c"
 
 [weakdeps]
 Tables = "bd369af6-aec1-5ad0-b16a-f7cc5008161c"
@@ -17,24 +18,7 @@ FITSIOTablesExt = "Tables"
 WCSExt = "WCS"
 
 [compat]
-Aqua = "0.8"
 CFITSIO = "1.7.0"
-OrderedCollections = "1"
 Printf = "<0.0.1, 1"
-Random = "<0.0.1, 1"
-Reexport = "0.2, 1.0"
 Tables = "1"
-Test = "<0.0.1, 1"
-WCS = "0.6.2"
-julia = "1.3"
-
-[extras]
-Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
-OrderedCollections = "bac558e1-5e72-5ebc-8fee-abe8a469f55d"
-Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
-Tables = "bd369af6-aec1-5ad0-b16a-f7cc5008161c"
-Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
-WCS = "15f3aee2-9e10-537f-b834-a6fb8bdb944d"
-
-[targets]
-test = ["Aqua", "OrderedCollections", "Random", "Tables", "Test", "WCS"]
+julia = "1.10"

Project.toml

@@ -11,9 +11,6 @@ Flexible Image Transport System (FITS) support for Julia
 [![codecov](https://codecov.io/gh/juliaastro/fitsio.jl/graph/badge.svg?token=SA9EG0z8pt)](https://codecov.io/gh/juliaastro/fitsio.jl)
 [![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-**Note:** The `Libcfitsio` submodule has been moved to [CFITSIO.jl](https://github.com/JuliaAstro/CFITSIO.jl) and will be deprecated in a future release.
-
-
 ## Usage
 
 For more in-depth usage and examples, see [the documentation](http://juliaastro.github.io/FITSIO.jl/stable/).

README.md

@@ -1,20 +1,10 @@
 # FITSIO.jl
 
-[![GitHub](https://img.shields.io/badge/Code-GitHub-black.svg)](https://github.com/JuliaAstro/FITSIO.jl)
-[![CI](https://github.com/JuliaAstro/FITSIO.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/JuliaAstro/FITSIO.jl/actions/workflows/CI.yml)
-[![codecov](https://codecov.io/gh/juliaastro/fitsio.jl/graph/badge.svg?token=SA9EG0z8pt)](https://codecov.io/gh/juliaastro/fitsio.jl)
+A [Julia](http://julialang.org) package for reading and writing Flexible Image Transport System (FITS) files, based on the [cfitsio](http://heasarc.gsfc.nasa.gov/fitsio/) library.
 
-A [Julia](http://julialang.org) package for reading and writing
-Flexible Image Transport System (FITS) files, based on the
-[cfitsio](http://heasarc.gsfc.nasa.gov/fitsio/) library.
+The interface is inspired by Erin Sheldon's [fitsio](https://github.com/esheldon/fitsio) Python package.
 
-The interface is inspired by Erin Sheldon's
-[fitsio](https://github.com/esheldon/fitsio) Python package.
-
-!!! warning
-    The `Libcfitsio` submodule has been moved to [CFITSIO.jl](https://github.com/JuliaAstro/CFITSIO.jl) and will be deprecated in a future release.
-
-# Installation
+## Installation
 
 `FITSIO.jl` can be installed using the built-in package manager:
 
@@ -26,7 +16,7 @@ pkg> add FITSIO
 DocTestFilters = r"File: [a-zA-Z0-9/._]+"
 ```
 
-# Quick start
+## Quick start
 
 The simplest way to write and read an image from a FITS file is by using the functions [`FITSIO.fitswrite`](@ref) and [`FITSIO.fitsread`](@ref).
 
@@ -47,16 +37,19 @@ julia> FITSIO.fitsread(fname, 1, 1:2, 1) # read a section of HDU number 1
  1
  3
 ```
+
 This is not the most performant way, as the file is opened and closed on every invocation. However, this abstracts away the complexity.
+
 !!! warn
     Currently, `fitswrite` overwrites an existing file, so this should be used with caution. In the future, this may allow
     appending to an existing file.
 
-# Usage
+## Usage
 
 In this example, we write to and read from a fits file.
 
 We create a new temporary file using the `FITS` constructor:
+
 ```jldoctest example
 julia> fname, _ = mktemp(); # create a temporary file for this example
 
@@ -70,12 +63,10 @@ No HDUs.
 julia> length(f) # shows the number of HDUs in the file
 0
 ```
+
 In this example, we have used the file mode `"w"`, which will overwrite any existing file with the same name. To append to an existing file instead, we use the mode `"r+"`, and to open a file for reading, we may specify the mode `"r"`.
 
-A FITS file consists of one or more header-data units (HDUs),
-concatenated one after the other. The `FITS` object therefore is
-represented as a collection of these HDUs. Each HDU can contain image data, or table data (either binary or
-ASCII-formatted). Since we have just created a new file, there are no HDUs currently in the file.
+A FITS file consists of one or more header-data units (HDUs), concatenated one after the other. The `FITS` object therefore is represented as a collection of these HDUs. Each HDU can contain image data, or table data (either binary or ASCII-formatted). Since we have just created a new file, there are no HDUs currently in the file.
 
 ## Image
 
@@ -223,6 +214,7 @@ Variable length columns are not supported by the `Tables.jl` interface, and `Tab
 In this section, we re-use the file that we had created in the eariler section, which contains an image HDU and a table HDU.
 
 We may read the header of an HDU as
+
 ```jldoctest example
 julia> header = read_header(imghdu)
 SIMPLE  =                    T / file does conform to FITS standard
@@ -240,6 +232,7 @@ FITSHeader
 julia> length(header) # number of keys
 8
 ```
+
 This reads the entire header from the HDU into memory. The header object behaves like a dictionary that may be queried using its keys:
 
 ```jldoctest example
@@ -276,7 +269,9 @@ julia> read_key(imghdu, 3) # query by key index
 julia> get_comment(header, "NAXIS")
 "number of data axes"
 ```
+
 We may modify the header in memory as
+
 ```jldoctest example
 julia> header["NEWKEY"] = 10;  # change or add a keyword
 
@@ -291,7 +286,6 @@ julia> get_comment(header, "NEWKEY")
 !!! note
     Manipulating a header only changes it in memory until it is written to disk. The header object in memory is not connected to the fits file. To write some header keywords in the new extension, pass a [`FITSHeader`](@ref) instance as a keyword: `write(f, data; header=header)`
 
-
 ## Iterating over the HDUs
 
 We may iterate over the fits file to access individual HDUs.
@@ -310,6 +304,7 @@ Close the file to write the in-memory FITS file to disk.
 ```jldoctest example
 julia> close(f)
 ```
+
 FITS objects are also closed automatically when garbage collected.
 
 !!! tip "Compressed storage"