Skip to content

Commit

Permalink
Small changes to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
marcobonici committed Sep 5, 2024
1 parent 5432106 commit c7d2797
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 6 deletions.
3 changes: 1 addition & 2 deletions docs/src/example.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,7 @@ Effort.get_Pℓ(input_test, bs, f, Pℓ_Mono_emu) # whole multipole computation
Here we are using a `ComponentEmulator`, which can compute one of the components as
predicted by PyBird, and a `MultipoleEmulator`, which emulates an entire multipole.

This computation is quite fast: a benchmark performed locally, with a 12th Gen Intel® Core™
i7-1260P, gives the following result for a multipole computation
This computation is quite fast: a benchmark performed locally, gives the following result for a multipole computation

```@example tutorial
benchmark[1]["Effort"]["Monopole"] # hide
Expand Down
8 changes: 4 additions & 4 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

`Effort` is a Julia package designed to emulate the computation of the Effective Field Theory of Large Scale Structure, as computed by [PyBird](https://github.com/pierrexyz/pybird). An emulator is a surrogate model, a computational technique that can mimick the behaviour of computationally expensive functions, with a speedup of several orders of magnitude.

The example page shows how to use Effort.jl, while showing its computational performance
The example page shows how to use `Effort`, while showing its computational performance

## Authors

- Marco Bonici, INAF - Institute of Space Astrophysics and Cosmic Physics (IASF), Milano
- Guido D'Amico, Università Degli Studi di Parma
- Marco Bonici, PostDoctoral Researcher at Waterloo Centre for Astrophysics
- Guido D'Amico, Associate Professor at Università Degli Studi di Parma

## Contributing

Expand All @@ -17,6 +17,6 @@ Please make sure to update tests as appropriate.

### License

Effort is licensed under the MIT "Expat" license; see
`Effort` is licensed under the MIT "Expat" license; see
[LICENSE](https://github.com/CosmologicalEmulators/Effort.jl/blob/main/LICENSE) for
the full license text.

0 comments on commit c7d2797

Please sign in to comment.