Skip to content

Commit

Permalink
docs: attempt to fix ci errors
Browse files Browse the repository at this point in the history
  • Loading branch information
fjebaker committed Sep 20, 2023
1 parent c9a8582 commit 2be9925
Showing 1 changed file with 3 additions and 7 deletions.
10 changes: 3 additions & 7 deletions docs/src/models.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
# Models index

```@setup model_plots
using SpectralFitting
```

Models wrapped from XSPEC implementations are prefixed with `XS_*`, whereas pure-Julia models are simply named, e.g. [`XS_PowerLaw`](@ref) in XSPEC vs [`PowerLaw`](@ref) in Julia.

The available models are
Expand Down Expand Up @@ -91,15 +87,15 @@ SpectralFitting.register_model_data

To generate the unicode plot to add as a fingerprint, we use a simple function:

```@example model_plots
using UnicodePlots
```@example
using SpectralFitting, UnicodePlots
function plotmodel(energy, model)
flux = invokemodel(energy, model)
lineplot(
energy[1:end-1],
flux,
title=String(SpectralFitting.model_base_name(typeof(model))),
title=String(SpectralFitting.FunctionGeneration.model_base_name(typeof(model))),
xlabel="E (keV)",
canvas=DotCanvas
)
Expand Down

1 comment on commit 2be9925

@fjebaker
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The surrogate stuff is just straight up out of date at the moment. Going to leave the docs CI failing for now.

Please sign in to comment.