|
| 1 | +--- |
| 2 | +title: "Tutorial: Register for Access to the Bilbao Crystallographic Server" |
| 3 | +--- |
| 4 | + |
| 5 | +<!--- Don't change the HTML version of this file; edit the .md version --> |
| 6 | + |
| 7 | +# Tutorial: Register for Access to the Bilbao Crystallographic Server |
| 8 | + |
| 9 | +* No exercise files are needed for this tutorial |
| 10 | + |
| 11 | +** Note that the process below is still being tested and developed. It |
| 12 | +may change. Please report any problems with this. ** |
| 13 | + |
| 14 | +## Intro |
| 15 | + |
| 16 | +There are a number of locations in GSAS-II where the Bilbao Crystallographic Server is accessed to perform computations requiring space group analysis. We would love to have some of these capabilities directly included into GSAS-II, we do not have the expertise in symmetry that the folks associated with that web site or the years of work that have been put into the capabilities available there. |
| 17 | + |
| 18 | +While one can use this server from a computer browser, access to it via software such as GSAS-II requires that you create a free account with their server and then obtain an "API Key" that is then supplied to GSAS-II. A number of short steps are required to obtain this API Key, as shown below: |
| 19 | + |
| 20 | +## Request a BCS account |
| 21 | + |
| 22 | +<BR clear=all> |
| 23 | +<img src="../imgs/BCS1.jpg" alt="Initial Registration Page" width="400px;" align="right"> |
| 24 | + |
| 25 | +- Use this URL to open the following page: [https://cryst.ehu.es/cgi-bin/cryst/programs/UserRegister.pl](https://cryst.ehu.es/cgi-bin/cryst/programs/UserRegister.pl). The web page to the right will open. |
| 26 | + |
| 27 | + Enter your e-mail address and press the "Apply" button. |
| 28 | + |
| 29 | + |
| 30 | +<BR clear=all><P> </P> |
| 31 | +<img src="../imgs/BCS2.jpg" alt="2nd Registration Page" width="400px;" align="right"> |
| 32 | + |
| 33 | +- Once you have pressed "Apply", you should see a page telling you that an e-mail has been sent to that address, as seen to the right: |
| 34 | + |
| 35 | +## Register for a BCS account |
| 36 | + |
| 37 | +The response to the previous web form should be an e-mail allong the lines of the following: |
| 38 | + |
| 39 | +>> Please click the following link to verify your email address and apply for an |
| 40 | +>> Bilbao Crystallographic Server user account: |
| 41 | +
|
| 42 | +>> https://cryst.ehu.es/cgi-bin/cryst/programs/UserRegister_form.pl?code=eyJzYWx0IjoiUFlYWGpvcmoiLCJlbWFpbCI6IkJy... |
| 43 | +
|
| 44 | +>> This link will expire in 24 hours. |
| 45 | +
|
| 46 | +>> If you didn't request this, please ignore this email. |
| 47 | +
|
| 48 | +>> BCS API Team |
| 49 | +
|
| 50 | +<BR clear=all> |
| 51 | +<img src="../imgs/BCS3.jpg" alt="Registration Page" width="400px;" align="right"> |
| 52 | + |
| 53 | +- Click on the provided link (or copy and paste it into a web browser) which should raise a window like the one to the right, where you will need to provide your name, an institution and a password. |
| 54 | + |
| 55 | + |
| 56 | +<BR clear=all><P> </P> |
| 57 | +<img src="../imgs/BCS4.jpg" alt="Registration Confirmation" width="400px;" align="right"> |
| 58 | + |
| 59 | +- After pressing "Register" on the above page, you will be told that your account has been established, as shown in the window to the right. |
| 60 | + |
| 61 | +## Create a BCS API Key |
| 62 | + |
| 63 | +<img src="../imgs/BCS5.jpg" alt="Login screen" width="400px;" align="right"> |
| 64 | + |
| 65 | +- Use the "login page" link in the web page above (or URL [ https://cryst.ehu.es/cgi-bin/cryst/programs/User_Login.pl]( https://cryst.ehu.es/cgi-bin/cryst/programs/User_Login.pl)), which will open a window like the one to the right. Enter your e-mail address and the password you created in the previous step and click on "Sign in". |
| 66 | + |
| 67 | +<BR clear=all> |
| 68 | +<img src="../imgs/BCS6.jpg" alt="Options after login" width="400px;" align="right"> |
| 69 | + |
| 70 | +- This will bring you to a page with account options, as shown to the right. Select the 4th option, "Create/Update API Key." |
| 71 | + |
| 72 | +<BR clear=all><P> </P> |
| 73 | +<img src="../imgs/BCS7.jpg" alt="Request API Key" width="400px;" align="right"> |
| 74 | + |
| 75 | +- The "Create/Update API Key" option opens the page to the right. Click on the "GENERATE A NEW API KEY" option. |
| 76 | + |
| 77 | +<BR clear=all><P> </P> |
| 78 | +<img src="../imgs/BCS8.jpg" alt="API Key generated" width="400px;" align="right"> |
| 79 | + |
| 80 | +- This will open a page displaying the key that you have generated, as shown to the right. Highlight the text beginning with BCS_ through the end of the line and use your browser's Copy command (usually control-C or on Mac Command-C). |
| 81 | +You should not let anyone else have access to your key. If there is excessive use by the key you have created, your access to the server will be blocked. |
| 82 | +(Don't bother trying to use the key in the figure here; it does not work). |
| 83 | + |
| 84 | +## Supply the BCS API Key to GSAS-II |
| 85 | + |
| 86 | +<BR clear=all> |
| 87 | +<img src="../imgs/BCS9.jpg" alt="Open GSAS-II Preference menu" width="225px;" align="right"> |
| 88 | + |
| 89 | +- Now open GSAS-II or use an existing GSAS-II session. In the File menu, use the Preferences menu command, as to the right. |
| 90 | + |
| 91 | +<BR clear=all><P> </P> |
| 92 | +<img src="../imgs/BCS10.jpg" alt="In Preference Window Select BCS_API_KEY" width="200px;" align="right"> |
| 93 | + |
| 94 | +- In the Preferences window, select configuration variable "BCS_API_KEY" in the pull-down list, |
| 95 | +as seen to the right. |
| 96 | + |
| 97 | +<BR clear=all><P> </P> |
| 98 | +<img src="../imgs/BCS11.jpg" alt="Request API Key" width="450px;" align="right"> |
| 99 | + |
| 100 | +- Once the configuration variable "BCS_API_KEY" has been selected in the pull-down list, the window to the right will be populated. Use the paste function (usually control-V or on Mac Command-V) to place the text into the entry box for the variable value. If that does not work, you will need to type it in manually. Press "Save current settings" and the window will close. |
| 101 | + |
| 102 | +## Test Access to BCS Using the API Key |
| 103 | + |
| 104 | +<BR clear=all> |
| 105 | +<img src="../imgs/BCS12.jpg" alt="Request API Key" width="250px;" align="right"> |
| 106 | + |
| 107 | +- Once the configuration variable "BCS_API_KEY" has been selected in the pull-down list, |
| 108 | +as a simple way to test that access has now been established, select any phase in your project. (If you do not have any phases, use "Add new phase" the data menu to create one.) That will bring up the Compute menu, which has an entry "Test Bilbao access", as seen to the right. |
| 109 | + |
| 110 | +<BR clear=all><P> </P> |
| 111 | +<img src="../imgs/BCS13.jpg" alt="Request API Key" width="300px;" align="right"> |
| 112 | + |
| 113 | +- After the "Test Bilbao access" menu command has been used, there will be a short delay, as information is sent to that web server, along with your API Key. When the reply is received, a message such as the one to the right should be displayed. |
| 114 | + |
| 115 | +<BR clear=all> |
| 116 | + |
| 117 | +- Should an error occur, one of the two following errors messages will be displayed: |
| 118 | + |
| 119 | +<img src="../imgs/BCS14.jpg" alt="Request API Key" width="300px"> |
| 120 | + <img src="../imgs/BCS15.jpg" alt="Request API Key" width="300px"> |
| 121 | +<BR clear=all><P> </P> |
0 commit comments