Skip to content
Snippets Groups Projects
Commit 5d121882 authored by Barry DeZonia's avatar Barry DeZonia
Browse files

Improve project README

parent b7753293
No related branches found
No related tags found
No related merge requests found
# Introduction
bphon-releases is the landing page for the software releases of the BPHON program
Description
# Description
BPHON is a plugin for [ChimeraX](https://www.rbvi.ucsf.edu/chimerax/)
that allows one to take molecular structures and synthetically generate
......@@ -9,9 +11,9 @@ a nmrPipe FT2 file that predicts NMR peak locations.
BPHON was designed by the team at NMRFAM at the University of Wisconsin
at Madison. Development began in 2023.
Download
# Download
Download the latest release package: LINK1
Download the latest release package: HERE
Earlier version links:
......@@ -19,57 +21,81 @@ Download
LINK3
etc
Install instructions
# Installation guide
Install ChimeraX on your computer
- Install ChimeraX on your computer
Visit this link: <https://www.cgl.ucsf.edu/chimerax/download.html>
Visit this link: https://www.cgl.ucsf.edu/chimerax/download.html
Download a version greater than or equal to 1.7
Download a version greater than or equal to 1.7
Install it using instructions at that site
Install it using instructions at that site
Install ShiftX2 on your computer
- Install nmrPipe on your computer
TODO: Must find instructions
- Install ShiftX2 on your computer
Visit this link: <https://weberdak.github.io/traj2nmr/html/source/installation.html#shiftx2>
Visit this link:
https://weberdak.github.io/traj2nmr/html/source/installation.html#shiftx2
Read the instructions on how to install ShiftX2
Read the instructions on how to install ShiftX2
Install it
Install it (and make sure that in your profile you set the env vars that are outlined in the instructions)
DO NOT INSTALL ANYTHING ELSE MENTIONED IN THOSE INSTRUCTIONS
DO NOT INSTALL ANYTHING ELSE MENTIONED IN THOSE INSTRUCTIONS
For instance stop following the install instructions when
the discussion gets to SPARTA+
Install BPHON in ChimeraX
- Install BPHON in ChimeraX
Start up ChimeraX from a csh or tcsh terminal shell. This is necessary
so that nmrPipe has its correct operating environment. Otherwise BPHON
will not be able to run simulations and you will get weird error reports.
(It is as simple as launching a bash terminal and then in that shell
enter "csh" or "tcsh").
start up ChimeraX
In ChimeraX's command window type "toolshed install <path-to-bphon.whl-file>"
in the command window type "devel install path-to-bphon/chimerax-plugin/tut_tool_qt"
It will go into the Tools :: General menu
It will go into the Tools :: General menu
Once BPHON has been installed try running it via the Tools :: General menu entry
The first time you launch BPHON you will get an error dialog related to the
"traj2nmr" package not being found.
Note: If you ever need to uninstall BPHON from chimerax do this:
Just close the dialog and restart chimerax (this should only ever need to be done once)
toolshed uninstall ChimeraX-BphonTool
Once again launch BPHON via the Tools :: General menu entry
to be safe exit and restart chimerax after doing so
A UI will be embedded on the lower right pane of ChimeraX and BPHON is ready
for use.
Once BPHON has been installed try running it via the Tools :: General menu entry
# Uninstall guide
The first time you launch BPHON you will get an error dialog related to the
"traj2nmr" package not being found.
If you ever need to uninstall BPHON from chimerax enter this in the chimerax command line:
toolshed uninstall ChimeraX-BphonTool
To make sure chimerax cleans up well, exit and restart chimerax
# LICENSE
Just close the dialog and restart chimerax
Copyright UW-Madison Board of Regents (2023-present). All rights reserved.
Once again launch BPHON via the Tools :: General menu entry
The Regents of the University of Wisconsin-Madison hereby grant the end user an internal, non-exclusive, non-commercial license to NMRFAM software for academic and scholarly purposes only. All rights reserved to the Regents of the University of Wisconsin-Madison. The end user agrees and acknowledges that redistribution to third parties not covered by this license is explicitly prohibited.
A UI will be embedded on the lower right pane of ChimeraX and BPHON is ready
for use.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
DOI
For non-academic use, please contact Justin Anderson at the Wisconsin Alumni Research Foundation (janderson@warf.org) to obtain a commercial license.
# How to cite
License
TODO Once publication is accepted, insert DOI, link and citation here
# DOI of software version(s)
TODO : Zenodo?
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment