diff --git a/source/core_tools/index.rst b/source/core_tools/index.rst new file mode 100644 index 0000000..3d329b1 --- /dev/null +++ b/source/core_tools/index.rst @@ -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 + + + \ No newline at end of file diff --git a/source/core_tools/libraries/dynamic_reentrant.rst b/source/core_tools/libraries/dynamic_reentrant.rst new file mode 100644 index 0000000..e768617 --- /dev/null +++ b/source/core_tools/libraries/dynamic_reentrant.rst @@ -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 `_ + +**Source Code** + +- `GitHub Repository `_ diff --git a/source/core_tools/libraries/index.rst b/source/core_tools/libraries/index.rst new file mode 100644 index 0000000..4525ae6 --- /dev/null +++ b/source/core_tools/libraries/index.rst @@ -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 + + dynamic_reentrant \ No newline at end of file diff --git a/source/core_tools/software/index.rst b/source/core_tools/software/index.rst new file mode 100644 index 0000000..334765e --- /dev/null +++ b/source/core_tools/software/index.rst @@ -0,0 +1,7 @@ +Software +======== + +.. toctree:: + :maxdepth: 1 + + rxn_rover \ No newline at end of file diff --git a/source/core_tools/software/rxn_rover.rst b/source/core_tools/software/rxn_rover.rst new file mode 100644 index 0000000..f784d9a --- /dev/null +++ b/source/core_tools/software/rxn_rover.rst @@ -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 `_ + +**Source Code** + +- `GitHub Repository `_ \ No newline at end of file diff --git a/source/first_party/analyzers/index.rst b/source/first_party/analyzers/index.rst index 4dabbe0..d527419 100644 --- a/source/first_party/analyzers/index.rst +++ b/source/first_party/analyzers/index.rst @@ -9,6 +9,7 @@ submit any questions as new issues tagged with "question". :maxdepth: 1 :caption: Infrared Spectroscopy + reactir_report_parser .. toctree:: :maxdepth: 1 diff --git a/source/first_party/analyzers/mock_lc_parser.rst b/source/first_party/analyzers/mock_lc_parser.rst index 7a15723..a4e785e 100644 --- a/source/first_party/analyzers/mock_lc_parser.rst +++ b/source/first_party/analyzers/mock_lc_parser.rst @@ -1,17 +1,28 @@ Mock LC Parser ============== +Description +----------- + Plugin class: Analyzer +This plugin generates and parses report files as if they were generated from a +liquid chromatograph (LC). The data generated is random and this plugin is only +meant to be used as a demonstration of a file parser as an analyzer plugin. + Acquisition ----------- -This plugin is available for download at -``_. +Download and install the plugin and required drivers from the official GitHub release pages listed below. -Description ------------ +**Downloads** -This plugin generates and parses report files as if they were generated from a -liquid chromatograph (LC). The data generated is random and this plugin is only -meant to be used as a demonstration of a file parser as an analyzer plugin. \ No newline at end of file +- **Plugin (.vip file):** + `Mock LC Parser Plugin – Releases `_ + +- **Drivers:** + This plugin does not require any additional drivers. + +**Source Code** + +- `Plugin Repository `_ \ No newline at end of file diff --git a/source/first_party/analyzers/reactir_report_parser.rst b/source/first_party/analyzers/reactir_report_parser.rst new file mode 100644 index 0000000..10cdecf --- /dev/null +++ b/source/first_party/analyzers/reactir_report_parser.rst @@ -0,0 +1,33 @@ +ReactIR Report Parser (in-development) +====================================== + +.. warning:: + + This plugin is currently in development and is **not publicly accessible at this time**. + +Description +----------- + +Plugin class: Analyzer + +This plugin parses report files output from a ReactIR(TM) to extract the peak intensity of an analyte. The plugin will average the results of any number of scans before reporting a new concentration value to Rxn Rover. A sample report is included with the plugin, whose format must be matched exactly for the parser to work. + +Note: The ReactIR trademark is owned by Mettler Toledo and its affiliated entities. + + +Acquisition +----------- + +Download and install the plugin from the official GitHub release page listed below. + +**Downloads** + +- **Plugin (.vip file):** + `React IR Report Parser Plugin – Releases `_ + +- **Drivers:** + This plugin does not require any additional drivers. + +**Source Code** + +- `Plugin Repository `_ \ No newline at end of file diff --git a/source/first_party/analyzers/waters_patrol_uplc_report_parser.rst b/source/first_party/analyzers/waters_patrol_uplc_report_parser.rst index e7fe145..5db1970 100644 --- a/source/first_party/analyzers/waters_patrol_uplc_report_parser.rst +++ b/source/first_party/analyzers/waters_patrol_uplc_report_parser.rst @@ -1,16 +1,11 @@ Waters |tm| Patrol |tm| UPLC |tm| Report Parser [#f1]_ ====================================================== -Plugin class: Optimizer - -Acquisition ------------ - -This plugin is available for download at ``_. - Description ----------- +Plugin class: Analyzer + 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. @@ -20,4 +15,21 @@ 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 \ No newline at end of file +.. |tm| unicode:: U+2122 .. TRADEMARK SYMBOL + +Acquisition +----------- + +Download and install the plugin from the official GitHub release page listed below. + +**Downloads** + +- **Plugin (.vip file):** + `Waters Patrol UPLC Report Parser – Releases `_ + +- **Drivers**: This plugin does not require any additional drivers. + +**Source Code** + +- `Plugin Repository `_ + diff --git a/source/first_party/optimizers/cyrxnopt.rst b/source/first_party/optimizers/cyrxnopt.rst new file mode 100644 index 0000000..f2ab3a9 --- /dev/null +++ b/source/first_party/optimizers/cyrxnopt.rst @@ -0,0 +1,33 @@ +CyRxnOpt (in-development) +========================= + +.. warning:: + + This plugin is currently in development and is **not publicly accessible at this time**. + +Description +----------- + +Plugin class: Optimizer + +CyRxnOpt is an advanced optimizer plugin which provides a singular interface to use many reaction optimization algorithms, AMLRO, EDBO+, SQSnobFit, and Nelder Mead Simplex. + + +Acquisition +----------- + +Download and install the plugin from the official GitHub release page listed below. + +**Downloads** + +- **Plugin (.vip file):** + `CyRxnOpt Plugin – Releases `_ + +- **Drivers:** + `CyRxnOpt Bindings – Releases `_ + +**Source Code** + +- `Plugin Repository `_ +- `Bindings Repository `_ +- `CyRxnOpt Python `_ \ No newline at end of file diff --git a/source/first_party/optimizers/deep_reaction_optimizer.rst b/source/first_party/optimizers/deep_reaction_optimizer.rst index dfd8f73..ea73197 100644 --- a/source/first_party/optimizers/deep_reaction_optimizer.rst +++ b/source/first_party/optimizers/deep_reaction_optimizer.rst @@ -3,15 +3,11 @@ Deep Reaction Optimizer Plugin class: Optimizer -Acquisition ------------ - -This plugin is available for download at -``_. - 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 @@ -19,4 +15,16 @@ 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. \ No newline at end of file +.. [#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. + + +Acquisition +------------ + +Download and install the plugin from the official GitHub release page listed below. + +**Downloads** + +**Source Code** + +- `Plugin Repository `_ \ No newline at end of file diff --git a/source/first_party/optimizers/index.rst b/source/first_party/optimizers/index.rst index 4bee5e7..a73df26 100644 --- a/source/first_party/optimizers/index.rst +++ b/source/first_party/optimizers/index.rst @@ -11,9 +11,11 @@ submit any questions as new issues tagged with "question". deep_reaction_optimizer sqsnobfit + cyrxnopt .. toctree:: :maxdepth: 1 :caption: Manual Control - rxn_queue + rxn_q + rxn_q_timing diff --git a/source/first_party/optimizers/rxn_q.rst b/source/first_party/optimizers/rxn_q.rst new file mode 100644 index 0000000..2eea844 --- /dev/null +++ b/source/first_party/optimizers/rxn_q.rst @@ -0,0 +1,33 @@ +Rxn Q (in-development) +====================== + +.. warning:: + + This plugin is currently in development and is **not publicly accessible at this time**. + +Description +----------- + +Plugin class: Optimizer + +Rxn Q is a Rxn Rover plugin and stand-alone LabVIEW program that performs a sequence of reaction conditions in the given order. A user can create a queue of reaction conditions using the Rxn Q user interface, or load the reaction queue from a formatted file (see CSV File Format section below). This sequence can be paused, modified or added to, and resumed during an experiment, although changes on the current or previous lines will not take effect! + +Note: No timing element is built into Rxn Q. The queue will proceed to the next set of reaction conditions immediately upon submitting the result for the current reaction conditions, or when the current line is skipped. + + +Acquisition +----------- + +Download and install the plugin from the official GitHub release page listed below. + +**Downloads** + +- **Plugin (.vip file):** + `Rxn Q Plugin – Releases `_ + +- **Drivers:** + This plugin does not require any additional drivers. + +**Source Code** + +- `Plugin Repository `_ \ No newline at end of file diff --git a/source/first_party/optimizers/rxn_q_timing.rst b/source/first_party/optimizers/rxn_q_timing.rst new file mode 100644 index 0000000..582e0a3 --- /dev/null +++ b/source/first_party/optimizers/rxn_q_timing.rst @@ -0,0 +1,33 @@ +Rxn Q With Timing (in-development) +================================== + +.. warning:: + + This plugin is currently in development and is **not publicly accessible at this time**. + +Description +----------- + +Plugin class: Optimizer + +Rxn Q is a Rxn Rover plugin and stand-alone LabVIEW program that performs a sequence of reaction conditions in the given order. A user can create a queue of reaction conditions using the Rxn Q user interface, or load the reaction queue from a formatted file (see CSV File Format section below). This sequence can be paused, modified or added to, and resumed during an experiment, although changes on the current or previous lines will not take effect! + +Note: Unlike the original Rxn Queue plugin, this version includes a timing element. The queue will proceed to the next set of reaction conditions after a specified delay, which can be set by the user. This allows for more controlled timing between reactions. + + +Acquisition +----------- + +Download and install the plugin from the official GitHub release page listed below. + +**Downloads** + +- **Plugin (.vip file):** + `Rxn Q With Timing – Releases `_ + +- **Drivers:** + This plugin does not require any additional drivers. + +**Source Code** + +- `Plugin Repository `_ \ No newline at end of file diff --git a/source/first_party/optimizers/rxn_queue.rst b/source/first_party/optimizers/rxn_queue.rst deleted file mode 100644 index 7df5aff..0000000 --- a/source/first_party/optimizers/rxn_queue.rst +++ /dev/null @@ -1,17 +0,0 @@ -Rxn Queue -========= - -Plugin class: Optimizer - -Acquisition ------------ - -This plugin is available for download at -``_. - -Description ------------ - -This plugin is a work-in-progress that will allow the user to provide a list -of reaction conditions to perform. Rxn Queue will allow Rxn Rover to -sequentially perform the provided reactions, logging the results. \ No newline at end of file diff --git a/source/first_party/optimizers/sqsnobfit.rst b/source/first_party/optimizers/sqsnobfit.rst index d4e6bb5..fb5d1d5 100644 --- a/source/first_party/optimizers/sqsnobfit.rst +++ b/source/first_party/optimizers/sqsnobfit.rst @@ -1,16 +1,11 @@ SQSnobFit ========= -Plugin class: Optimizer - -Acquisition ------------ - -This plugin is available for download at ``_. - Description ----------- +Plugin class: Optimizer + This plugin allows Rxn Rover to connect with an instance of `SQSnobFit `_, a Python reimplementation of the `SNOBFIT `_ blackbox @@ -18,4 +13,21 @@ optimization algorithm. A Python program is provided with the plugin to launch an instance of SQSnobFit for use with this plugin. This program uses a modified objective function with built-in communication capabilities. The SQSnobFit algorithm, along with other aspects of the program, can be -configured by specifying a configuration file (example files are provided). \ No newline at end of file +configured by specifying a configuration file (example files are provided). + +Acquisition +----------- + +Download and install the plugin from the official GitHub release pages listed below. + +**Downloads** + +- **Plugin (.vip file):** + `SQSnobFit Plugin – Releases `_ + +- **Drivers:** + This plugin does not require any additional drivers. + +**Source Code** +- `Plugin Repository `_ +- `SQSnobFit Remote Optimization Repository `_ \ No newline at end of file diff --git a/source/first_party/reactor_components/chromtech_nextgen_pumps.rst b/source/first_party/reactor_components/chromtech_nextgen_pumps.rst index d00324b..999eec8 100644 --- a/source/first_party/reactor_components/chromtech_nextgen_pumps.rst +++ b/source/first_party/reactor_components/chromtech_nextgen_pumps.rst @@ -1,18 +1,34 @@ ChromTech Next Generation Pumps =============================== -Plugin class: Reactor component - -Acquisition ------------ - -This plugin is available for download at -``_. - Description ----------- +Plugin class: Pump Controller + This plugin provides basic control over ChromTech Next Generation pumps, including flow rate control, start and stop commands, and pressure monitoring. The plugin keeps a log of all data collected in a CSV format for easy analysis -using a spreadsheet program. \ No newline at end of file +using a spreadsheet program. + +- **Supported Hardware:** ChromTech Next Generation Pumps + +Acquisition +----------- + +Download and install the plugin and required drivers from the official GitHub release pages listed below. + +**Downloads** + +- **Plugin (.vip file):** + `ChromTech NextGen Pump Plugin – Releases `_ + +- **Required Drivers:** + `ChromTech NextGen Drivers – Releases `_ + +**Source Code** + +- `Plugin Repository `_ +- `Driver Repository `_ + + diff --git a/source/first_party/reactor_components/chromtech_series_iii_pump.rst b/source/first_party/reactor_components/chromtech_series_iii_pump.rst index 599fe53..3614446 100644 --- a/source/first_party/reactor_components/chromtech_series_iii_pump.rst +++ b/source/first_party/reactor_components/chromtech_series_iii_pump.rst @@ -1,18 +1,32 @@ -ChromTech Series Pump -===================== - -Plugin class: Reactor component - -Acquisition ------------ - -This plugin is available for download at -``_. +ChromTech Series III Pump +========================= Description ----------- +Plugin class: Pump Controller + This plugin provides basic control over the ChromTech Series III pump, including flow rate control, start and stop commands, and pressure monitoring. The plugin keeps a log of all data collected in a CSV format for easy analysis -using a spreadsheet program. \ No newline at end of file +using a spreadsheet program. + +- **Supported Hardware:** ChromTech Series III pump + +Acquisition +----------- + +Download and install the plugin and required drivers from the official GitHub release pages listed below. + +**Downloads** + +- **Plugin (.vip file):** + `ChromTech Series III Plugin – Releases `_ + +- **Required Drivers:** + `ChromTech Series III Drivers – Releases `_ + +**Source Code** + +- `Plugin Repository `_ +- `Driver Repository `_ \ No newline at end of file diff --git a/source/first_party/reactor_components/index.rst b/source/first_party/reactor_components/index.rst index bd4e913..ec92b2c 100644 --- a/source/first_party/reactor_components/index.rst +++ b/source/first_party/reactor_components/index.rst @@ -12,6 +12,8 @@ submit any questions as new issues tagged with "question". chromtech_nextgen_pumps chromtech_series_iii_pump omega_platinum_series_temperature + milligat_pump + polar_bear_plus .. toctree:: :maxdepth: 1 diff --git a/source/first_party/reactor_components/milligat_pump.rst b/source/first_party/reactor_components/milligat_pump.rst new file mode 100644 index 0000000..ffd6bbb --- /dev/null +++ b/source/first_party/reactor_components/milligat_pump.rst @@ -0,0 +1,32 @@ +MilliGAT Pump (in-development) +============================== + +.. warning:: + + This plugin is currently in development and is **not publicly accessible at this time**. + +Description +----------- + +Plugin class: Pump Controller + +This plugin provides basic control over a MilliGAT pump from GlobalFIA, including flow rate control, start and stop commands. The plugin keeps a log of all data collected in a CSV format for easy analysis using a spreadsheet program. + +- **Supported Hardware:** MilliGAT Pump from `GlobalFIA `_ + +Acquisition +----------- + +Download and install the plugin from the official GitHub release page listed below. + +**Downloads** + +- **Plugin (.vip file):** + `MilliGAT Pump Plugin – Releases `_ + +- **Drivers:** + MilliGAT pump drivers are required to communicate with the pumps. These drivers can be obtained from GlobalFIA using their information email, **info@globalfia.com**. Once the drivers are downloaded, extract the files into your ``/instr.lib directory`` directory, where ```` is the location of your LabVIEW installation. + +**Source Code** + +- `Plugin Repository `_ \ No newline at end of file diff --git a/source/first_party/reactor_components/mock_pump_controller.rst b/source/first_party/reactor_components/mock_pump_controller.rst index 8923aaf..dab16ac 100644 --- a/source/first_party/reactor_components/mock_pump_controller.rst +++ b/source/first_party/reactor_components/mock_pump_controller.rst @@ -1,18 +1,31 @@ Mock Pump Controller ==================== +Description +----------- + Plugin class: Simulated component +This plugin simulates basic control over a liquid pump, including flow rate +control, start and stop commands, and pressure monitoring. The plugin keeps +a log of all data collected in a CSV format for easy analysis using a +spreadsheet program. + +- **Supported Hardware:** Mock Pump Controller (simulated component) + Acquisition ----------- -This plugin is available for download at -``_. +Download and install the plugin and required drivers from the official GitHub release pages listed below. -Description ------------ +**Downloads** -This plugin simulates basic control over a liquid pump, including flow rate -control, start and stop commands, and pressure monitoring. The plugin keeps -a log of all data collected in a CSV format for easy analysis using a -spreadsheet program. \ No newline at end of file +- **Plugin (.vip file):** + `Mock Pump Controller Plugin – Releases `_ + +- **Drivers:** + This plugin does not require any additional drivers. + +**Source Code** + +- `Plugin Repository `_ \ No newline at end of file diff --git a/source/first_party/reactor_components/mock_temperature_controller.rst b/source/first_party/reactor_components/mock_temperature_controller.rst index 6161276..2ec0733 100644 --- a/source/first_party/reactor_components/mock_temperature_controller.rst +++ b/source/first_party/reactor_components/mock_temperature_controller.rst @@ -1,18 +1,31 @@ Mock Temperature Controller =========================== +Description +----------- + Plugin class: Simulated component +This plugin simulates basic control over a temparature controller, including +temperature control, monitoring, start, and stop commands. The plugin keeps a +log of all data collected in a CSV format for easy analysis using a spreadsheet +program. + +- **Supported Hardware:** Mock Temperature Controller (simulated component) + Acquisition ----------- -This plugin is available for download at -``_. +Download and install the plugin and required drivers from the official GitHub release pages listed below. -Description ------------ +**Downloads** -This plugin simulates basic control over a temparature controller, including -temperature control, monitoring, start, and stop commands. The plugin keeps a -log of all data collected in a CSV format for easy analysis using a spreadsheet -program. \ No newline at end of file +- **Plugin (.vip file):** + `Mock Temperature Controller Plugin – Releases `_ + +- **Drivers:** + This plugin does not require any additional drivers. + +**Source Code** + +- `Plugin Repository `_ \ No newline at end of file diff --git a/source/first_party/reactor_components/omega_platinum_series_temperature.rst b/source/first_party/reactor_components/omega_platinum_series_temperature.rst index d61964b..007f5c5 100644 --- a/source/first_party/reactor_components/omega_platinum_series_temperature.rst +++ b/source/first_party/reactor_components/omega_platinum_series_temperature.rst @@ -1,18 +1,32 @@ Omega Platinum Series ===================== -Plugin class: Reactor component +Description +----------- + +Plugin class: Temperature Controller + +This plugin provides basic control over Omega Platinum Series temperature +controllers, including temperature control, monitoring, start, and stop +commands. The plugin keeps a log of all data collected in a CSV format for +easy analysis using a spreadsheet program. + +- **Supported Hardware:** Omega Platinum Series Temperature Controllers Acquisition ----------- -This plugin is available for download at -``_. +Download and install the plugin and required drivers from the official GitHub release pages listed below. -Description ------------ +**Downloads** -This plugin provides basic control over Omega Platinum Series temparature -controllers, including temperature control, monitoring, start, and stop -commands. The plugin keeps a log of all data collected in a CSV format for -easy analysis using a spreadsheet program. \ No newline at end of file +- **Plugin (.vip file):** + `Omega Platinum Series Plugin – Releases `_ + +- **Required Drivers:** + `Omega Platinum Series Drivers – Releases `_ + +**Source Code** + +- `Plugin Repository `_ +- `Driver Repository `_ \ No newline at end of file diff --git a/source/first_party/reactor_components/polar_bear_plus.rst b/source/first_party/reactor_components/polar_bear_plus.rst new file mode 100644 index 0000000..39b0938 --- /dev/null +++ b/source/first_party/reactor_components/polar_bear_plus.rst @@ -0,0 +1,36 @@ +Polar Bear Plus (in-development) +================================ + +.. warning:: + + This plugin is currently in development and is **not publicly accessible at this time**. + +Description +----------- + +Plugin class: Temperature Controller + +- **Supported Hardware:** Polar Bear Plus + + +Acquisition +----------- + +Download and install the plugin from the official GitHub release page listed below. + +.. warning:: + + Due to depreciated functionality in the Eurotherm nanodac drivers, this plugin is currently compatible with LabVIEW 2020 and earlier. + +**Downloads** + +- **Plugin (.vip file):** + `Polar Bear Plus Plugin – Releases `_ + +- **Drivers:** + `Polar Bear Plus Drivers - Releases `_ + `Eurotherm nanodac Controller Drivers ` + +**Source Code** + +- `Plugin Repository `_ \ No newline at end of file diff --git a/source/index.rst b/source/index.rst index 340c03c..ce20f8c 100644 --- a/source/index.rst +++ b/source/index.rst @@ -17,13 +17,22 @@ plugin, or learn a little bit about us! :caption: Third-Party Plugins Plugin Classes + +.. toctree:: + :maxdepth: 2 + :caption: Core Tools + + core_tools/libraries/index + core_tools/software/index .. toctree:: :maxdepth: 1 :caption: Submissions - - submissions/index - + + submissions/getting_started + submissions/plugin_submission_form + submissions/submit_a_plugin + .. toctree:: :maxdepth: 1 :caption: The Rxn Rover Team diff --git a/source/submissions/getting_started.rst b/source/submissions/getting_started.rst index 9af58f4..b0deb84 100644 --- a/source/submissions/getting_started.rst +++ b/source/submissions/getting_started.rst @@ -1,12 +1,12 @@ Getting Started -=============== +================ Creating a Plugin ----------------- A plugin submission begins with creating a useful plugin worth submitting! Tutorials for creating plugins are hosted on the `Rxn Rover documentation -website `_. Plugins can be +website `_. Plugins can be created using a provided template (:doc:`first- ` or :doc:`third- ` party), or diff --git a/source/submissions/index.rst b/source/submissions/index.rst index 12f890b..4f4e9b3 100644 --- a/source/submissions/index.rst +++ b/source/submissions/index.rst @@ -1,3 +1,6 @@ +Submissions +=========== + .. toctree:: :maxdepth: 1 diff --git a/source/submissions/plugin_submission_form.rst b/source/submissions/plugin_submission_form.rst index a2b82e7..9a41c60 100644 --- a/source/submissions/plugin_submission_form.rst +++ b/source/submissions/plugin_submission_form.rst @@ -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 ` +Description +----------- + +Plugin class: Plugin Class Name + +A brief description of the plugin describing: +* What the plugin is used for (including applicable information like what + hardware it works on) +* Plugin Capabilities + +- **Supported Hardware:** Example Hardware Acquisition ----------- A brief statement about how to acquire the plugin. For example: -This plugin is available for download at ``. +**Downloads** -Description ------------ +- **Plugin (.vip file):** + `Plugin Name Plugin – Releases `_ -A brief description of the plugin describing: -* What the plugin is used for (including applicable information like what - hardware it works on) -* Plugin Capabilities \ No newline at end of file +- **Required Drivers:** + `Required Drivers – Releases `_ + +**Source Code** + +- `Plugin Repository `_ \ No newline at end of file diff --git a/source/submissions/submit_a_plugin.rst b/source/submissions/submit_a_plugin.rst index a006705..8fdca2f 100644 --- a/source/submissions/submit_a_plugin.rst +++ b/source/submissions/submit_a_plugin.rst @@ -1,5 +1,5 @@ Submit a Plugin -=================== +================ .. note:: This page assumes that you have already read and completed the tasks in