Skip to content

Commit 6481d8e

Browse files
Running OpenVnmrJ section and TOC added
1 parent 74786cf commit 6481d8e

File tree

1 file changed

+71
-12
lines changed

1 file changed

+71
-12
lines changed

README.md

Lines changed: 71 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,58 @@
1-
<p align="center">
2-
<img alt="A splash image for installation script." width="480px" height="182px" src="https://user-images.githubusercontent.com/52927689/218594750-e8f8009f-d60e-4e51-872a-eb274e0709a1.png">
3-
</p>
4-
5-
# OpenVnmrJ_WSL
6-
<a href="https://github.com/OpenVnmrJ/OpenVnmrJ">OpenVnmrJ</a> is free and open-source software for processing NMR spectroscopy data. It runs on Ubuntu 20.04 and Red Hat 7.5+ & 8+ based Linux ditributions as well as macOS 10.13+. This Powershell script is used to install and configure Windows Subsystem for Linux and OpenVnmrJ on Windows 10+ as an alternative to installing within a virtual machine. WSL provides a native application experience and can result in a smaller installation footprint and faster application startup times.
1+
<h1 align="center">
2+
<a href="https://github.com/JessiBaughman/OpenVnmrJ_WSL">
3+
<img alt="A splash image for installation script." width="640px" height="240px" src="https://user-images.githubusercontent.com/52927689/218879398-e6befea4-01cf-439a-aa2a-3937209f552b.png">
4+
</a>
5+
</h1>
6+
7+
<div align="center">
8+
<a href="https://github.com/JessiBaughman/OpenVnmrJ_WSL/issues/new?assignees=&labels=bug&template=01_BUG_REPORT.md&title=bug%3A+">Report a Bug</a>
9+
</div>
10+
11+
[![license](https://img.shields.io/github/license/JessiBaughman/OpenVnmrJ_WSL)](LICENSE) ![GitHub last commit](https://img.shields.io/github/last-commit/JessiBaughman/OpenVnmrJ_WSL)
12+
<details open="open">
13+
<summary>Table of Contents</summary>
14+
15+
- [About](#about)
16+
- [Getting Started](#getting-started)
17+
- [Prerequisites](#prerequisites)
18+
- [Administer Privileges](#administer-privileges)
19+
- [Windows version](#windows-version)
20+
- [BIOS](#bios)
21+
- [Windows Features](#windows-features)
22+
- [Usage / Running the script](#usage--running-the-script)
23+
- [Running OpenVnmrJ](#running-openvnmrj)
24+
- [Launching OpenVnmrJ](#launching-openvnmrj)
25+
- [Printing / Plotting](#printing--plotting)
26+
- [Closing OpenVnmrJ](#closing-openvnmrj)
27+
- [License](#license)
28+
29+
</details>
30+
31+
## About
32+
<a href="https://github.com/OpenVnmrJ/OpenVnmrJ">OpenVnmrJ</a> is free and open-source software for processing NMR spectroscopy data. It runs on Ubuntu 20.04 and Red Hat 7/8 based Linux ditributions as well as macOS 10.13+. This Powershell script is used to install and configure Windows Subsystem for Linux and OpenVnmrJ on Windows 10+ as an alternative to installing within a virtual machine. WSL provides a native application experience and can result in a smaller installation footprint and faster application startup times.
733

834
<p>
935
<br />
1036
</p>
1137

12-
## Prerequisites
38+
## Getting Started
39+
40+
### Prerequisites
1341

14-
### Administer Privileges
42+
#### Administer Privileges
1543
Some parts of the script will require administrator privileges to install, configure, or update. You will be prompted on the secure desktop each time.
1644

17-
### Windows version
45+
#### Windows version
1846
To find your version of Windows, open the Settings panel (`Windows + I`) and navigate to System->About.
1947

2048
* **Windows 10** : Version 2004 (aka 20H1, Build 19041, released Spring 2020) or later
2149

2250
* **Windows 11** : Version 21H2 (Build 22000, released Fall 2021) or later
2351

24-
### BIOS
52+
#### BIOS
2553
You will need to enable virtualization in your system BIOS. Entering the BIOS configuration at boot and the label of the virtualization setting itself varies between motherboard manufacturers. You may be able to find detailed instructions by searching your computer model number or manufacturer's name.
2654

27-
### Windows Features
55+
#### Windows Features
2856
<p align="center">
2957
<img alt="The Windows Features panel" width="415px" height="368px" src="https://user-images.githubusercontent.com/52927689/218584527-d098fb02-ded6-4171-98bf-a67fd5db776a.png">
3058
</p>
@@ -34,7 +62,7 @@ Two features need to be installed and activated within Windows. These are the "V
3462
<br />
3563
</p>
3664

37-
## Installation / Running the script
65+
### Usage / Running the script
3866

3967
1. **Unlock the script**
4068
- Right-click on the .ps1 file and click Properties. Check to see if there is a section at the bottom that reads, "Security: This file came from another computer and might be blocked to help protect this computer." If so, click the Unblock checkbox and click OK.
@@ -92,3 +120,34 @@ Two features need to be installed and activated within Windows. These are the "V
92120
10. **Press Enter to close the Powershell window**
93121
- An installation log is not automatically saved. If you wish to save a log, copy the Powershell contents before pressing Enter.
94122

123+
<p>
124+
<br />
125+
</p>
126+
127+
## Running OpenVnmrJ
128+
![Running_small](https://user-images.githubusercontent.com/52927689/218871609-11f6ac0e-ff1c-4c80-aa66-1d46d0e87ce6.png)
129+
### Launching OpenVnmrJ
130+
* The easiest way to launch OpenVnmrJ is to used the created shortcuts. To launch manually:
131+
* Windows 10: Launch VcXsrv using the "VcXsrv with Xauthority" shortcut in the Start Menu or Run:
132+
* `%ProgramFiles%\VcXsrv\vcxsrv.exe -multiwindow -clipboard -wgl -auth "%UserProfile%\.Xauthority"`
133+
* Open WSL (Ubuntu-20.04) and type `vnmrj`
134+
135+
### Printing / Plotting
136+
* Print to file commmands will work as expected. File paths are within Ubuntu, so to save to Windows, navigate to `/mnt/c` to access the `C:` drive.
137+
* Output created using the `plot` command will be sent to the PDF printer and saved to the directory selected during install.
138+
<p align="center">
139+
<img alt="Printer selection within the Plot panel of OpenVnmrJ" width="373px" height="248px" src="https://user-images.githubusercontent.com/52927689/218859889-5975e8e9-df79-45da-8329-e5b5aa3340c4.png">
140+
</p>
141+
142+
* You can toggle between color and grayscale plots by selecting the corresponding version of the PDF printer either from the File->Printers... window or the "Send to" drop-down menu within the Processing->Plot panel.
143+
144+
### Closing OpenVnmrJ
145+
* OpenVnmrJ can be exited in the standard methods
146+
* File->Exit VnmrJ, close the window, or type `exit` on the command line
147+
* **Windows 10:** Once closed, you will need to manually exit VcXsrv from the taskbar if desired.
148+
149+
## License
150+
151+
This project is licensed under the **MIT license**. Feel free to edit and distribute this template as you like.
152+
153+
See [LICENSE](LICENSE) for more information.

0 commit comments

Comments
 (0)