Skip to content

Commit

Permalink
docs/tutorial/04-factory.md: link to updated tutorial (#1231)
Browse files Browse the repository at this point in the history
I don't think there is any plans to update this documentation, but we
could at least make a link to the updated material.
  • Loading branch information
veprbl authored Jan 21, 2024
1 parent f1d22c2 commit cf7f7f5
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
7 changes: 3 additions & 4 deletions docs/howto/add_factory.md
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
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

0 comments on commit cf7f7f5

Please sign in to comment.