From cf7f7f512f0bc9e37adabb573fca1c7e26a3db3e Mon Sep 17 00:00:00 2001 From: Dmitry Kalinkin Date: Sat, 20 Jan 2024 21:25:56 -0500 Subject: [PATCH] docs/tutorial/04-factory.md: link to updated tutorial (#1231) I don't think there is any plans to update this documentation, but we could at least make a link to the updated material. --- docs/howto/add_factory.md | 7 +++---- docs/tutorial/04-factory.md | 3 +++ 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/howto/add_factory.md b/docs/howto/add_factory.md index 54fa8a52d5..0e13961169 100644 --- a/docs/howto/add_factory.md +++ b/docs/howto/add_factory.md @@ -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 diff --git a/docs/tutorial/04-factory.md b/docs/tutorial/04-factory.md index dcea229ccd..1c123d51ec 100644 --- a/docs/tutorial/04-factory.md +++ b/docs/tutorial/04-factory.md @@ -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.

Understand the directory structure for where the factory should be placed in the source tree.

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