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

docs/tutorial/04-factory.md: link to updated tutorial #1231

Merged
merged 3 commits into from
Jan 21, 2024
Merged

docs/tutorial/04-factory.md: link to updated tutorial #1231

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7d70c23
docs/tutorial/04-factory.md: link to updated tutorial
veprbl Jan 13, 2024
6c8423b
docs/howto/add_factory.md: add link to updated tutorial
veprbl Jan 16, 2024
4a33e69
04-factory.md: consistent bold font
veprbl Jan 18, 2024
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
7 changes: 3 additions & 4 deletions docs/howto/add_factory.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
# Adding a reconstruction algorithm to EICrecon
# Notice

_Please note that these instructions may change at any time. There are plans
to rearrange where some of the general algorithm files are kept, but the
schedule for this is not yet set._
**This section of the tutorial is outdated due to switch from `JFactory` to `JOmniFactory`. Refer to a [tutorial on reconstruction algorithms](https://eic.github.io/tutorial-reconstruction-algorithms/) for up-to-date information.**

# Adding a reconstruction algorithm to EICrecon

In JANA, algorithms are kept in `JFactory` classes. These are the classes that
interact with the JANA framework to match requests for certain objects or
Expand Down
3 changes: 3 additions & 0 deletions docs/tutorial/04-factory.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
|----------------------------------------------------------------------------------------|----------|-----------|------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------|
| Creating or modifying a JANA factory in order to implement a reconstruction algorithm | 15 | 20 | How to write a reconstruction algorithm in EICrecon? | Learn how to create a new factory in EICrecon that supplies a reconstruction algorithm for all to use.<br/><br/>Understand the directory structure for where the factory should be placed in the source tree.<br/><br/>Understand how to use a generic algorithm in a JANA factory. | Create a factory for reconstructing single subdetector data or for global reconstruction. |

## Notice

**This section of the tutorial is outdated due to switch from `JFactory` to `JOmniFactory`. Refer to a [tutorial on reconstruction algorithms](https://eic.github.io/tutorial-reconstruction-algorithms/) for up-to-date information.**

## Introduction

Expand Down
Loading