-
Notifications
You must be signed in to change notification settings - Fork 0
master <-- Update/documentation #4
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.
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
Merged
Merged
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 7bef97e
Update formatting and other mistakes
JohnBrittaein 1e994b1
Updated Submission form
JohnBrittaein 3cde30b
Updated TItle to match Series III
JohnBrittaein cffb5fa
Fixed typo
JohnBrittaein e870090
Removed requirements section, and other minor tweaks
JohnBrittaein f2b4b79
fixed typo
JohnBrittaein 2b414c4
Added listings for current plugins (in-development)
JohnBrittaein cca774d
update plugin catalog (in-development)
JohnBrittaein 417cc28
fixed build warnings
JohnBrittaein 33388ca
Fixed visual bug where the titles within submissions were not shown i…
JohnBrittaein f09833f
Completed catalog listings
JohnBrittaein 7c5b0c9
Added new Core-Tools sections to include links to non-plugin related …
JohnBrittaein 59f4772
Update source/core_tools/libraries/DynamicReentrant.rst
JohnBrittaein 2e7622d
Update source/first_party/analyzers/waters_patrol_uplc_report_parser.rst
JohnBrittaein 433fbe5
Update source/first_party/optimizers/deep_reaction_optimizer.rst
JohnBrittaein a64814f
Update source/first_party/optimizers/rxn_q_timing.rst
JohnBrittaein f5eeb5c
de-nest submissions and core_tools to fix repetitous labels in sidebar
JohnBrittaein ef3a65a
remove snake_case
JohnBrittaein b85bb36
remove snake case
JohnBrittaein 32b9067
rename to rxn_q
JohnBrittaein 2609e2f
added review suggestions
JohnBrittaein 476d2f8
Review Changes
JohnBrittaein 59bf411
Update source/first_party/analyzers/reactir_report_parser.rst
JohnBrittaein File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
|
|
||
|
|
||
|
|
JohnBrittaein marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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, | ||
JohnBrittaein marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| 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>`_ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |
JohnBrittaein marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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>`_ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| Software | ||
| ======== | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
|
|
||
| RxnRover |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zachcran marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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. | ||
JohnBrittaein marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| **Source Code** | ||
|
|
||
| - `Plugin Repository <https://github.com/RxnRover/>`_ | ||
| - `Plugin Repository <https://github.com/RxnRover/plugin_milligat_pump>`_ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JohnBrittaein marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| Getting Started | ||
| =============== | ||
| ================ | ||
|
|
||
| Creating a Plugin | ||
| ----------------- | ||
|
|
||
JohnBrittaein marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,6 @@ | ||
| Submissions | ||
| =========== | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| Name of the Plugin | ||
| ================== | ||
| =================== | ||
|
|
||
| Description | ||
| ----------- | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.