Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dox fix #244

Merged
merged 4 commits into from
Dec 12, 2023
Merged

Dox fix #244

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9804a37
fixed broken contrib link in doxygen
m-fila Dec 11, 2023
4df7c3a
fixed typos
m-fila Dec 11, 2023
280e330
fixed links to master/main branch
m-fila Dec 12, 2023
a1ee79d
updated ReadmeLinks script with master/main change
m-fila Dec 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,11 +73,6 @@ endif()
#--- target for Doxygen documentation ------------------------------------------
if(BUILD_DOCS)
include(cmake/EDM4HEPDoxygen.cmake)
# copy images needed for documentation to build folder and install them
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/doc/edm4hep_diagram.svg
${CMAKE_CURRENT_BINARY_DIR}/doxygen/html/doc/edm4hep_diagram.svg COPYONLY)
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/doxygen/html/doc/edm4hep_diagram.svg
DESTINATION ${CMAKE_INSTALL_DOCDIR})
Comment on lines -76 to -80
Copy link
Contributor

Choose a reason for hiding this comment

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

This does not make the edm4hep diagram disappear on the main page?

Copy link
Member

Choose a reason for hiding this comment

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

Maybe not because it uses the README which has a link to it but I haven't tested it

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Doxygen copies the file on its own when generating html from md. Some older version perhaps required manual intervention

$ find build -name edm4hep_diagram.svg
build/doxygen/html/edm4hep_diagram.svg

$ find InstallArea/ -name edm4hep_diagram.svg
InstallArea/share/doc/EDM4HEP/doxygen/doxygen/html/edm4hep_diagram.svg

endif()

#--- add version files ---------------------------------------------------------
Expand Down
31 changes: 15 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,30 +12,30 @@ A generic event data model for future HEP collider experiments.

| | | |
|-|-|-|
| [Vector3f](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L11) | [Vector3d](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L26) | [Vector2i](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L42) |
| [Vector2f](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L56) | [TrackState](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L70) | [ObjectID](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L93) |
| [Quantity](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L105) | [Hypothesis](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L113) | [HitLevelData](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L120) |
| [Vector3f](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L11) | [Vector3d](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L26) | [Vector2i](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L42) |
| [Vector2f](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L56) | [TrackState](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L70) | [ObjectID](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L93) |
| [Quantity](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L105) | [Hypothesis](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L113) | [HitLevelData](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L120) |


**Datatypes**

| | | |
|-|-|-|
| [EventHeader](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L130) | [MCParticle](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L140) | [SimTrackerHit](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L209) |
| [CaloHitContribution](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L243) | [SimCalorimeterHit](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L255) | [RawCalorimeterHit](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L267) |
| [CalorimeterHit](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L276) | [ParticleID](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L288) | [Cluster](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L301) |
| [TrackerHit](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L322) | [TrackerHitPlane](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L339) | [RawTimeSeries](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L360) |
| [Track](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L373) | [Vertex](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L392) | [ReconstructedParticle](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L409) |
| [SimPrimaryIonizationCluster](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L513) | [TrackerPulse](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L531) | [RecIonizationCluster](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L544) |
| [TimeSeries](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L555) | [RecDqdx](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L567) | |
| [EventHeader](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L130) | [MCParticle](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L140) | [SimTrackerHit](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L209) |
| [CaloHitContribution](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L243) | [SimCalorimeterHit](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L255) | [RawCalorimeterHit](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L267) |
| [CalorimeterHit](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L276) | [ParticleID](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L288) | [Cluster](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L301) |
| [TrackerHit](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L322) | [TrackerHitPlane](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L339) | [RawTimeSeries](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L360) |
| [Track](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L373) | [Vertex](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L392) | [ReconstructedParticle](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L409) |
| [SimPrimaryIonizationCluster](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L513) | [TrackerPulse](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L531) | [RecIonizationCluster](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L544) |
| [TimeSeries](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L555) | [RecDqdx](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L567) | |

**Associations**

| | | |
|-|-|-|
| [MCRecoParticleAssociation](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L439) | [MCRecoCaloAssociation](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L448) | [MCRecoTrackerAssociation](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L457) |
| [MCRecoTrackerHitPlaneAssociation](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L466) | [MCRecoCaloParticleAssociation](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L475) | [MCRecoClusterParticleAssociation](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L484) |
| [MCRecoTrackParticleAssociation](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L493) | [RecoParticleVertexAssociation](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L502) | |
| [MCRecoParticleAssociation](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L439) | [MCRecoCaloAssociation](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L448) | [MCRecoTrackerAssociation](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L457) |
| [MCRecoTrackerHitPlaneAssociation](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L466) | [MCRecoCaloParticleAssociation](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L475) | [MCRecoClusterParticleAssociation](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L484) |
| [MCRecoTrackParticleAssociation](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L493) | [RecoParticleVertexAssociation](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L502) | |

The tests and examples in the `tests` directory show how to read, write, and use these types in your code.

Expand Down Expand Up @@ -74,7 +74,7 @@ The library files and dictionaries (`libedm4hep.so`, ...) must be put somewhere

## Python bindings
There are python bindings for all the classes in the datamodel for working with
the clases individually (for working with collections podio has its own
the classes individually (for working with collections podio has its own
bindings). Make sure that `<CMAKE_INSTALL_PREFIX>/lib` is in `LD_LIBRARY_PATH`,
`<CMAKE_PREFIX_PATH>/python` is in `PYTHONPATH` and `<CMAKE_INSTALL_PREFIX>/include` is in `ROOT_INCLUDE_PATH`:
```python
Expand Down Expand Up @@ -129,5 +129,4 @@ of the input file should be part of the output.

## Contributing

Contributions and bug reports are welcome! See our [contributing
guidelines](./doc/contributing.md) if you want to contribute code to EDM4hep.
Contributions and bug reports are welcome! See our [contributing guidelines](doc/contributing.md) if you want to contribute code to EDM4hep.
2 changes: 1 addition & 1 deletion doc/DoxygenLayout.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<tab type="mainpage" visible="yes" title=""/>
<tab type="user" visible="yes" title="Key4HEP Home Page" url="https://cern.ch/key4hep"/>
<tab type="pages" visible="no" title="" intro=""/>
<tab type="user" visible="yes" title="Contribution Guide" url="md_doc_contributing.html"/>
<tab type="user" visible="yes" title="Contribution Guide" url="@ref md_doc_2contributing"/>
<tab type="modules" visible="yes" title="" intro=""/>
<tab type="namespaces" visible="yes" title="">
<tab type="namespacelist" visible="yes" title="" intro=""/>
Expand Down
2 changes: 1 addition & 1 deletion doc/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ a PR, as we only allow *rebase merges* for PRs.

git push downstream <myNewBranch>

- reload your own github website (https://github.com/<yourUserName>/EDM4HEP)
- reload your own Github website (https://github.com/<yourUserName>/EDM4HEP)
- you should see your commit
- now you can create a pull request on the web site

Expand Down
4 changes: 2 additions & 2 deletions scripts/updateReadmeLinks.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ def check_readme_links():

links_are_ok = True
for readme_line in readme_content:
edm4hep_objects = re.findall("\[(.*?)\]\(https:\/\/github.com\/key4hep\/EDM4hep\/blob\/master\/edm4hep\.yaml#L(\d+?)\)", readme_line)
edm4hep_objects = re.findall("\[(.*?)\]\(https:\/\/github.com\/key4hep\/EDM4hep\/blob\/main\/edm4hep\.yaml#L(\d+?)\)", readme_line)
if edm4hep_objects:
for edm4hep_object, original_line_number in edm4hep_objects:
regex = f".*edm4hep::{edm4hep_object} *: *"
Expand All @@ -32,7 +32,7 @@ def check_readme_links():
sys.exit(1)
if edm4hep_yaml_line_numbers_with_match[0] != original_line_number:
links_are_ok = False
readme_line = readme_line.replace(f"[{edm4hep_object}](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L{original_line_number})", f"[{edm4hep_object}](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L{edm4hep_yaml_line_numbers_with_match[0]})")
readme_line = readme_line.replace(f"[{edm4hep_object}](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L{original_line_number})", f"[{edm4hep_object}](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L{edm4hep_yaml_line_numbers_with_match[0]})")
print(f"{edm4hep_object} is wrongly linked (line {original_line_number} --> {edm4hep_yaml_line_numbers_with_match[0]})")
new_readme_content += readme_line
return links_are_ok, new_readme_content
Expand Down
Loading