For the users¶
Note
If you encounter an issue during installation, see our troubleshooting section. If that doesn’t resolve your issue, please create a bug report on our Github issue tracker.
See also
If you do not have Python or have an older version of Python, you may visit the Python downloads or Anaconda websites and follow their instructions on installing Python.
Installing nmrcryspy¶
PIP is a package manager for Python packages and is included with python version 3.4 and higher. PIP is the easiest way to install Python packages. Install the package using pip as follows,
$ pip install nmrcryspy
For Mac users, if the above statement didn’t work, you are probably using MacOS system python, in which case, use the following,
$ python3 -m pip install nmrcryspy --user
If you get a PermissionError, it usually means that you do not have the administrative access
to install new packages to your Python installation. In this case, you may consider adding the
--user option at the end of the statement to install the package into your home directory.
You can read more about how to do this in the
pip documentation.
Building and Installing
Use the terminal/Prompt to navigate into the directory containing the package (usually, the folder is named nmrcryspy),
$ cd nmrcryspy
From within the source code folder, type the following in the terminal to install the library.
$ pip install .
If you get an error that you don’t have the permission to install the package into
the default site-packages directory, you may try installing with the --user
options as,
$ pip install . --user
Updating nmrcryspy¶
If you are upgrading to a newer version of nmrcryspy, you should have all the prerequisites already installed on your system. In this case, type the following in the terminal/Prompt
$ pip install nmrcryspy -U
All done! You may now start using the library or proceed to Basic Usage to continue the tutorial.