Giter Club home page Giter Club logo

nmrpoise's Introduction

Parameter Optimisation by Iterative Spectral Evaluation

GitHub Actions Build Status GitHub Actions Documentation Status PyPI version License Zenodo DOI

Jonathan Yong and Mohammadali Foroozandeh, University of Oxford

Anal. Chem. 2021, 93 (31), 10735โ€“10739. DOI: 10.1021/acs.analchem.1c01767


Overview

POISE is a Python package for the numerical optimisation of NMR parameters. It works by iteratively acquiring NMR spectra with different parameters and using a cost function to determine the optimal point.

The software comprises two parts:

  • the user-facing frontend, which runs in Bruker's TopSpin software. It can be executed from the TopSpin command line, or called from an AU or Python script (the documentation contains more instructions on this).

  • the backend, which is hidden from the user; it runs on a system installation of Python 3.6+.


Installation

To install POISE, you will need:

  • TopSpin. The minimum tested version is 3.6; however, this should work on any version of TopSpin that has Python 2.7 internally bundled (older versions of Python 2 are not currently supported). To check which version of Python comes with TopSpin, follow these instructions.

    Note that other instrument manufacturers are not currently supported.

  • Python 3.6 or later. This refers to a system installation, which is entirely separate from that in TopSpin. Please download and install that (many instructions are available online).

POISE can then be installed using pip (which uses the system installation of Python):

python -m pip install nmrpoise   # or 'python3'

If any errors occur, please see the documentation, or contact us.

To upgrade or reinstall POISE use:

python -m pip install --upgrade nmrpoise --no-cache-dir

Note that the --no-cache-dir flag is necessary if you are reinstalling (its purpose is explained in the documentation).


Documentation

The documentation is hosted at https://foroozandehgroup.github.io/nmrpoise; it contains complete instructions on how to set POISE up and use it.

There is also a video guide available at https://www.youtube.com/watch?v=QTCeSCRZs4I.


Contact us

Any feedback, questions, or bugs? Please create a GitHub issue or email us: we can be reached at [email protected].

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.