Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
8965dac
Updated download links and information with .vip file pointing toward…
JohnBrittaein Jul 1, 2025
7bef97e
Update formatting and other mistakes
JohnBrittaein Jul 1, 2025
1e994b1
Updated Submission form
JohnBrittaein Jul 1, 2025
3cde30b
Updated TItle to match Series III
JohnBrittaein Jul 1, 2025
cffb5fa
Fixed typo
JohnBrittaein Jul 1, 2025
e870090
Removed requirements section, and other minor tweaks
JohnBrittaein Jul 1, 2025
f2b4b79
fixed typo
JohnBrittaein Jul 1, 2025
2b414c4
Added listings for current plugins (in-development)
JohnBrittaein Jul 3, 2025
cca774d
update plugin catalog (in-development)
JohnBrittaein Jul 3, 2025
417cc28
fixed build warnings
JohnBrittaein Jul 3, 2025
33388ca
Fixed visual bug where the titles within submissions were not shown i…
JohnBrittaein Jul 25, 2025
f09833f
Completed catalog listings
JohnBrittaein Jul 25, 2025
7c5b0c9
Added new Core-Tools sections to include links to non-plugin related …
JohnBrittaein Jul 25, 2025
59f4772
Update source/core_tools/libraries/DynamicReentrant.rst
JohnBrittaein Aug 5, 2025
2e7622d
Update source/first_party/analyzers/waters_patrol_uplc_report_parser.rst
JohnBrittaein Aug 5, 2025
433fbe5
Update source/first_party/optimizers/deep_reaction_optimizer.rst
JohnBrittaein Aug 5, 2025
a64814f
Update source/first_party/optimizers/rxn_q_timing.rst
JohnBrittaein Aug 5, 2025
f5eeb5c
de-nest submissions and core_tools to fix repetitous labels in sidebar
JohnBrittaein Aug 5, 2025
ef3a65a
remove snake_case
JohnBrittaein Aug 5, 2025
b85bb36
remove snake case
JohnBrittaein Aug 5, 2025
32b9067
rename to rxn_q
JohnBrittaein Aug 5, 2025
2609e2f
added review suggestions
JohnBrittaein Aug 5, 2025
476d2f8
Review Changes
JohnBrittaein Aug 11, 2025
59bf411
Update source/first_party/analyzers/reactir_report_parser.rst
JohnBrittaein Aug 12, 2025
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
19 changes: 19 additions & 0 deletions source/core_tools/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Core Tools
==========

This section provides a listing of official software tools used by Rxn Rover. These are not plugins, but software components that provide functionality to Rxn Rover itself.

.. toctree::
:maxdepth: 2
:caption: Software

software/index

.. toctree::
:maxdepth: 2
:caption: Libraries

libraries/index



24 changes: 24 additions & 0 deletions source/core_tools/libraries/DynamicReentrant.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
.. _dynamic-reentrant:

Dynamic Reentrant Library
=========================

Description
-----------

The Dynamic Reentrant library facilitates communication between Rxn Rover and its plugins, and helps manage dynamic reentrant VIs.
This library is essential for first-party(and likely most other third-party) plugins to work with Rxn Rover,

Acquisition
-----------

Download and install from the official GitHub release pages listed below.

**Downloads**

- **Quick Installer via VIPM (.vip file):**
`Dynamic Reentrant – Releases <https://github.com/RxnRover/DynamicReentrant/releases>`_

**Source Code**

- `GitHub Repository <https://github.com/RxnRover/DynamicReentrant>`_
8 changes: 8 additions & 0 deletions source/core_tools/libraries/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Libraries
=========
This section lists libraries created by Rxn Rover's team that are used for the functionality of Rxn Rover.

.. toctree::
:maxdepth: 1

DynamicReentrant
24 changes: 24 additions & 0 deletions source/core_tools/software/RxnRover.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
.. _rxnrover-software:

Rxn Rover Software
==================

Description
-----------

Rxn Rover is an open-source, modular automation platform for reaction discovery and optimization.
Primarily targetting smaller research groups, it is designed using interchangeable plugins to be flexible and easy to integrate into a variety of laboratory environments.

Acquisition
-----------

Download and install from the official GitHub release pages listed below. Also ensure you have installed DynamicReentrant which can be found here :ref:`dynamic-reentrant`.

**Downloads**

- **Quick Installer via VIPM (.vip file):**
`Rxn Rover – Releases <https://github.com/RxnRover/RxnRover/releases>`_

**Source Code**

- `GitHub Repository <https://github.com/RxnRover/RxnRover>`_
7 changes: 7 additions & 0 deletions source/core_tools/software/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Software
========

.. toctree::
:maxdepth: 1

RxnRover
26 changes: 18 additions & 8 deletions source/first_party/analyzers/waters_patrol_uplc_report_parser.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,11 @@
Waters |tm| Patrol |tm| UPLC |tm| Report Parser [#f1]_
======================================================

Plugin class: Optimizer

Acquisition
-----------

This plugin is available for download at `<https://github.com/RxnRover/plugin_waters_patrol_uplc_report_parser>`_.

Description
-----------

Plugin class: Optimizer

This plugin parses report files output from Waters |tm| Patrol |tm| program to
extract the concentration of an analyte. The plugin will average the results
of three injections before reporting a new concentration value to Rxn Rover.
Expand All @@ -20,4 +15,19 @@ exactly for the parser to work.
.. [#f1] The Waters |tm|, Patrol |tm|, UPLC |tm| trademarks are owned by Waters
Corporation and its affiliated entities.

.. |tm| unicode:: U+2122 .. TRADEMARK SYMBOL
.. |tm| unicode:: U+2122 .. TRADEMARK SYMBOL

Acquisition
-----------

Download and install the plugin from the official GitHub release page listed below.

**Downloads**

- **Plugin (.vip file):**
`MilliGAT Pump Plugin – Releases <https://github.com/RxnRover/plugin_waters_patrol_uplc_report_parser/releases>`_

**Source Code**

- `Plugin Repository <https://github.com/RxnRover/plugin_waters_patrol_uplc_report_parser>`_

25 changes: 18 additions & 7 deletions source/first_party/optimizers/deep_reaction_optimizer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,31 @@ Deep Reaction Optimizer

Plugin class: Optimizer

Acquisition
-----------

This plugin is available for download at
`<https://github.com/RxnRover/plugin_dro>`_.

Description
-----------

Plugin class: Optimizer

This plugin allows Rxn Rover to connect with an instance of the Deep Reaction
Optimizer. [#dro]_ A Python program is provided with the plugin to launch an
instance of DRO for use with this plugin. This program uses a modified
objective function with built-in communication capabilities. The DRO algorithm,
along with other aspects of the program, can be configured by specifying a
configuration file (example files are provided).

.. [#dro] Zhou, Z.; Li, X.; Zare, R. N., Optimizing Chemical Reactions with Deep Reinforcement Learning. ACS Central Science 2017, 3 (12), 1337-1344.; DOI: 10.1021/acscentsci.7b00492; Code available at: https://github.com/lightingghost/chemopt.
.. [#dro] Zhou, Z.; Li, X.; Zare, R. N., Optimizing Chemical Reactions with Deep Reinforcement Learning. ACS Central Science 2017, 3 (12), 1337-1344.; DOI: 10.1021/acscentsci.7b00492; Code available at: https://github.com/lightingghost/chemopt.


Aqcquisition
------------

Download and install the plugin from the official GitHub release page listed below.

**Downloads**

- **Plugin (.vip file):**
`CyRxnOpt Plugin – Releases <https://github.com/RxnRover/plugin_dro/releases>`_

**Source Code**

- `Plugin Repository <https://github.com/RxnRover/plugin_dro>`_
8 changes: 4 additions & 4 deletions source/first_party/optimizers/rxn_q_timing.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Rxn Queue With Timing (in-development)
======================================
Rxn Q With Timing (in-development)
==================================

.. warning::

Expand All @@ -23,11 +23,11 @@ Download and install the plugin from the official GitHub release page listed bel
**Downloads**

- **Plugin (.vip file):**
`Rxn Queue With Timing – Releases <https://github.com/RxnRover/>`_
`Rxn Queue With Timing – Releases <https://github.com/RxnRover/plugin_rxn_q_timing/releases>`_

- **Drivers:**
This plugin does not require any additional drivers.

**Source Code**

- `Plugin Repository <https://github.com/RxnRover/>`_
- `Plugin Repository <https://github.com/RxnRover/plugin_rxn_q_timing>`_
4 changes: 2 additions & 2 deletions source/first_party/optimizers/rxn_queue.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Rxn Queue (in-development)
==========================
Rxn Q (in-development)
======================

.. warning::

Expand Down
4 changes: 2 additions & 2 deletions source/first_party/reactor_components/milligat_pump.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ Download and install the plugin from the official GitHub release page listed bel
**Downloads**

- **Plugin (.vip file):**
`MilliGAT Pump Plugin – Releases <https://github.com/RxnRover/>`_
`MilliGAT Pump Plugin – Releases <https://github.com/RxnRover/plugin_milligat_pump/releases>`_

- **Drivers:**
MilliGAT pump drivers are required to communicate with the pumps. These drivers can be obtained from GlobalFIA using their information email, **[email protected]**. Once the drivers are downloaded, extract the files into your <labview>/instr.lib directory, where <labview> is the location of your LabVIEW installation.

**Source Code**

- `Plugin Repository <https://github.com/RxnRover/>`_
- `Plugin Repository <https://github.com/RxnRover/plugin_milligat_pump>`_
7 changes: 4 additions & 3 deletions source/first_party/reactor_components/polar_bear_plus.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,12 @@ Download and install the plugin from the official GitHub release page listed bel
**Downloads**

- **Plugin (.vip file):**
`Polar Bear Plus Plugin – Releases <https://github.com/RxnRover/>`_
`Polar Bear Plus Plugin – Releases <https://github.com/RxnRover/plugin_polar_bear_plus/releases>`_

- **Drivers:**
This plugin does not require any additional drivers.
`Polar Bear Plus Drivers - Releases <https://github.com/RxnRover/driver_polar_bear_plus/releases>`_
`Eurotherm nanodac Controller Drivers <https://sine.ni.com/apps/utf8/niid_web_display.download_page?p_id_guid=CDE89C1186CB633BE0440021287E6E02>`

**Source Code**

- `Plugin Repository <https://github.com/RxnRover/>`_
- `Plugin Repository <https://github.com/RxnRover/plugin_polar_bear_plus>`_
8 changes: 7 additions & 1 deletion source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,19 @@ plugin, or learn a little bit about us!
:caption: Third-Party Plugins

Plugin Classes <third_party/index>

.. toctree::
:maxdepth: 2
:caption: Core Tools

core_tools/index

.. toctree::
:maxdepth: 1
:caption: Submissions

submissions/index

.. toctree::
:maxdepth: 1
:caption: The Rxn Rover Team
Expand Down
2 changes: 1 addition & 1 deletion source/submissions/getting_started.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Getting Started
===============
================

Creating a Plugin
-----------------
Expand Down
3 changes: 3 additions & 0 deletions source/submissions/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
Submissions
===========

.. toctree::
:maxdepth: 1

Expand Down
2 changes: 1 addition & 1 deletion source/submissions/plugin_submission_form.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Plugin Submission Form
======================
=======================

This plugin submission form will serve as both a request to have your plugin
added to the `Rxn Rover Plugin Catalog GitHub Repository <https://github.com/
Expand Down
2 changes: 1 addition & 1 deletion source/submissions/submission_form.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Name of the Plugin
==================
===================

Description
-----------
Expand Down
2 changes: 1 addition & 1 deletion source/submissions/submit_a_plugin.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Submit a Plugin
===================
================

.. note::
This page assumes that you have already read and completed the tasks in
Expand Down