Skip to content

Commit

Permalink
Fix the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
peremato committed Mar 20, 2024
1 parent 7d97dae commit 4f5139d
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 10 deletions.
10 changes: 5 additions & 5 deletions docs/src/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,31 +5,31 @@ Documentation for `EDM4hep.jl` public interface.
## Index - Types
```@index
Pages = ["api.md"]
Modules = [EDM4hep, EDM4hep.RootIO, EDM4hep.Histograms]
Modules = [EDM4hep, EDM4hep.RootIO, EDM4hep.Histograms, EDM4hep.Analysis]
Order = [:type]
```
## Index - Functions
```@index
Pages = ["api.md"]
Modules = [EDM4hep, EDM4hep.RootIO, EDM4hep.Histograms]
Modules = [EDM4hep, EDM4hep.RootIO, EDM4hep.Histograms, EDM4hep.Analysis]
Order = [:function]
```

## Modules
```@autodocs
Modules = [EDM4hep, EDM4hep.RootIO]
Modules = [EDM4hep, EDM4hep.RootIO, EDM4hep.Analysis]
Order = [:module]
```
## Types
This is the list of all types defined for EDM4hep using the PODIO yaml file.

```@autodocs
Modules = [EDM4hep, EDM4hep.RootIO, EDM4hep.Histograms]
Modules = [EDM4hep, EDM4hep.RootIO, EDM4hep.Histograms, EDM4hep.Analysis]
Order = [:type]
```
## Functions
```@autodocs
Modules = [EDM4hep, EDM4hep.RootIO, EDM4hep.Histograms]
Modules = [EDM4hep, EDM4hep.RootIO, EDM4hep.Histograms, EDM4hep.Analysis]
Order = [:function]
```

Expand Down
9 changes: 6 additions & 3 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,7 @@ There are a number of issues and problems still to be resolved. We keep track of
- Generate doc string with member information - *DONE*
- Generate accessors for one-to-many relations, vector members - *DONE*
- Support latest version (RC2) of RNTuple format (waiting for a file being generated)
- Support for multi-threading (i.e. be able to add `@threads` in the event loop)

- Support for multi-threading (i.e. be able to add `@threads` in the event loop) - *DONE*

## Tests
Unit tests can be run with `julia --project=. test/runtests.jl`
Expand Down Expand Up @@ -79,9 +78,13 @@ for p in mcps
end
```
### examples/FCC/analysis_mH-recoil.jl
This is basically the example `higgs/mH-recoil/mumu` from [FCCAnalyses](https://github.com/HEP-FCC/FCCAnalyses). It shows in a realistic manner hoe to develop analysis functions using the Data Types from EDM4hep to created high-level analysis functions.
This is basically the example `higgs/mH-recoil/mumu` from [FCCAnalyses](https://github.com/HEP-FCC/FCCAnalyses). It shows in a realistic manner how to develop analysis functions using the Data Types from EDM4hep to created high-level analysis functions.
The Jupyter notebook [analysis_mH-recoil.ipynb](./assets/analysis_mH-recoil.pdf) shows the same example in form of a notebook.

### examples/FCC/analysis_MT.jl
This is basically the example `higgs/mH-recoil/mumu` from [FCCAnalyses](https://github.com/HEP-FCC/FCCAnalyses) in a multi-threaded mode.
The Jupyter notebook [analysis_mH-recoil.ipynb](./assets/analysis_mH-recoil-MT.pdf) shows the same example in form of a notebook.

## EDM4hep Data Model
This is the diagram for the EDM4hep datamodel including relationships.

Expand Down
2 changes: 1 addition & 1 deletion examples/FCC/analysis_MT.jl
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ mydata.df |> describe |> println
@time do_analysis!(mydata, myanalysis!, reader, subset; mt=true);
#Profile.clear_malloc_data()
@info "MT 2nd run"
@time do_analysis!(mydata, myanalysis!, reader, subset);
@time do_analysis!(mydata, myanalysis!, reader, subset; mt=true);
println("Processed events: $(mydata.pevts), selected: $(mydata.sevts)")
mydata.df |> describe |> println

Expand Down
2 changes: 1 addition & 1 deletion src/RootIO.jl
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,7 @@ module RootIO
"""
get(reader::Reader, treename::String)
Opens a 'TTree' in the ROOT file (typically the events tree).
Opens a 'TTree' or 'RNTuple' in the ROOT file (typically the events tree).
It returns a 'LazyTree' that allows the user to iterate over
events.
"""
Expand Down

0 comments on commit 4f5139d

Please sign in to comment.