Skip to content

change company name to Rxn Rover/update install instructions #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.

Sign up for GitHub

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

Open
JohnBrittaein wants to merge 6 commits into
base: master
Choose a base branch
from
Open

change company name to Rxn Rover/update install instructions #4

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3eb62aa
change company name to Rxn Rover
JohnBrittaein Aug 20, 2025
866b4a7
fixed typo in name 'isntructions' to 'instructions'
JohnBrittaein Aug 21, 2025
95cf469
added .vip install guide and clarified setting it up via command prom…
JohnBrittaein Aug 21, 2025
6b6fedf
Update install_instructions.txt
JohnBrittaein Aug 30, 2025
19924ab
remove install_instructions.txt and update build file
JohnBrittaein Aug 30, 2025
f3e7f12
delete install_instructions.txt
JohnBrittaein Aug 30, 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
13 changes: 9 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ 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).

## Installation

### Prerequisites

This plugin requires the following to be installed beforehand:
Expand All @@ -20,7 +18,12 @@ This plugin requires the following to be installed beforehand:
Package Manager (VIPM) or can be downloaded from the [ZeroMQ for LabVIEW
website](https://labview-zmq.sourceforge.io/).

### Getting the Plugin
## Installation

1. Download the latest `.vip` installer from the [Releases page](https://github.com/RxnRover/plugin_sqsnobfit/releases/latest).
2. Double-click the downloaded `.vip` file to install it with VIPM.

### Manual Installation (optional)

Download this plugin by clicking the "Code" button in the top right of its
GitHub repository and selecting "Download ZIP". Extract the ZIP file into your
Expand All @@ -41,7 +44,9 @@ Linux or Mac, simply type `make install` in the `sqsnobfit_remote_optimizer`
directory to download and install dependencies into a virtual environment.

If using Windows, open a terminal in the `sqsnobfit_remote_optimizer`
directory and type the following commands:
directory, but make sure it's a Command Prompt(CMD) window not PowerShell.

In the terminal window type the following commands:

```batch
python -m venv venv # Creates a virtual environment (venv)
Expand Down
2 changes: 1 addition & 1 deletion install_isntructions.txt → install_instructions.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Setting up SQSnobFit Optimizer
------------------------------
Inside <documents>/Plugins/Optimizers/SQSnobFit there are two folders, plugin, where the Rxn Rover plugin resides, and sqsnobfit_remote_optimizer, where the necessary code to launch an instance of SQSnobFit that can communicate with the plugin. If you are using Linux or Mac, simply type make install in the sqsnobfit_remote_optimizer directory to download and install dependencies into a virtual environment.

If using Windows, open a terminal in the sqsnobfit_remote_optimizer directory and type the following commands:
If using Windows, open a terminal(Command Prompt, not powershell) in the sqsnobfit_remote_optimizer directory and type the following commands:


python -m venv venv # Creates a virtual environment (venv)
Expand Down
Loading