MagresView 2.0 - NMR crystallography visualisation app
If you want to run MagresView 2.0 (offline) on your local machine, you need to get the gh-pages branch of the code as this contains the pre-built app.
You can get the current version here:
https://github.com/CCP-NC/magresview-2/archive/refs/heads/gh-pages.zip
Once downloaded, you no longer need an internet connection. You simply unzip the file and run a local web server (see below), which will create a directory called magresview-2-gh-pages.
Alternatively, if you prefer, you can instead use git to download the gh-pages branch:
git clone -b gh-pages https://github.com/CCP-NC/magresview-2.git
This will create a directory called magresview-2 within which you'll find the index.html file.
Unfortunately, the index.html file often cannot be opened directly from your local machine in modern browsers. Instead, you need to run a local web server. There are many options for doing this, depending on what software you have installed on your machine. Here are some common options:
| Command | |
|---|---|
| Python | python -m http.server 8000 |
| Node.js | npx http-server -p 8000 |
| Ruby | ruby -run -e httpd . -p 8000 |
| PHP | php -S localhost:8001 |
Having run any of these commands from within the magresview-2 or magresview-2-gh-pages directory, you should now be able to open a browser and navigate to http://localhost:8000 to view the app.This will work without any internet connection.
Alternatively, if you have the Visual Studio Code editor installed, you can use the Live Server extension to run the app locally.
Check out docs/DevArchitecture.md for an explanation of the structure of the software and conventions to adopt.