update to readme #23

randalld-aws · 2020-01-28T02:05:15Z

reworking steps to resolve some issues on Mac

Issue #, if available:

Description of changes:

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

reworking steps to resolve some issues on Mac

Changed to remove Conda and download repo zip files instead of configure SSH

Clean up to remove Conda, misc formatting

Formatting change

avawang1 · 2020-01-28T18:24:14Z

README.md


-### Install the braket-python-sdk package
-Use the following commands to install the Braket Python SDK package. 
+### Download the Amazon Braket GitHub Repositories


Should we include instructions on installing the braket SDKs using the SSH keys?

There was so much confusion around this that we opted for the simple route of just downloading the zip files directly as it requires just the user log in to Git. We'll have to resolve this for the next update so folks can go git pull on the repo.

avawang1 · 2020-01-28T18:25:42Z

README.md

@@ -130,7 +168,8 @@ There are currently three simulators available for Amazon Braket. To specify whi
 3. Replace the `AWS_ACCOUNT_ID` in the value for `s3_folder` to your 12-digit AWS account ID. It should look similar to the following:
   `s3_folder = ("braket-output-123456789012", "folder-name")`
 4. Save the file with the name `bellpair.py`.
-5. Run the following command to run the Python file:
+5. Use the file system to copy or move the file to your virtual environment. For example, in Windows, use File Explorer to open the `braket` folder in your virtual environment, then paste the file into the braket folder. Confirm that the file was moved to the correct location by viewing the contacts of the folder, such as with the `dir` command in Windows.


I think it should also be fine to activate your virtual environment and then run "python bellpair.py"

I am not sure what your proposed update is.

Proposed update : "Make sure braketvirtenv is activated and run 'python bellpair.py'"

If we have the below step #6, we don't need step #5 anymore.

I don't understand. Bellpair.py doesn't exist until one creates it

Step #4 saves the file and thus creates it

avawang1 · 2020-01-28T18:26:34Z

README.md

@@ -140,11 +179,22 @@ You should see a result similar to the following:
 #### To validate your configuration using a Jupyter notebook
 See [Installing the Jupyter Software](https://jupyter.org/install) for information about how to install Jupyter. You can use either JupyterLab or classic Jupyter Notebook.

+Run the following commands to install Jupyter and then create a Braket kernal.


avawang1 · 2020-01-28T18:27:32Z

README.md

-Jupyter opens in a browser window. Choose **New**, and then under **Notebooks**, choose **Python3**.
+Jupyter opens in a browser window. Choose **New**, and then under **Notebooks**, choose **braket**. 
+
+**Note** If you are using a Jupyter notebook from an prior installation and did not create a Braket kernel, you will not see braket available for the notebook type. Choose Python3 instead.


Can you add a comment - "If you use Python3, you will need to have the Braket packages installed globally"

avawang1 · 2020-01-28T18:28:14Z

README.md

-device_arn = "arn:aws:aqx:::qpu:ionq"
+from braket.aws import AwsQpu
+
+device = AwsQpu("arn:aws:aqx:::qpu:ionq")


I don't think we should use ionq as the example, since it takes a long time to get the result back. Rigetti?

addressing feedback from Ava

added a note about jobs taking up to 24 hours on IonQ

modified descriptions of simulators.

avawang1 · 2020-01-28T19:43:09Z

README.md

-Jupyter opens in a browser window. Choose **New**, and then under **Notebooks**, choose **Python3**.
+Jupyter opens in a browser window. Choose **New**, and then under **Notebooks**, choose **braket**. 
+
+**Note** If you are using a Jupyter notebook from an prior installation and did not create a Braket kernel, you will not see braket available for the notebook type. Choose Python3 instead. If you choose Python3, you must have Python envrironment variables set globally.


It's not really Python environment variables. "If you choose Python 3, you must have Braket packages installed globally and not in the virtualenv."

avawang1 · 2020-01-28T19:44:03Z

README.md

@@ -130,7 +168,8 @@ There are currently three simulators available for Amazon Braket. To specify whi
 3. Replace the `AWS_ACCOUNT_ID` in the value for `s3_folder` to your 12-digit AWS account ID. It should look similar to the following:
   `s3_folder = ("braket-output-123456789012", "folder-name")`
 4. Save the file with the name `bellpair.py`.
-5. Run the following command to run the Python file:
+5. Use the file system to copy or move the file to your virtual environment. For example, in Windows, use File Explorer to open the `braket` folder in your virtual environment, then paste the file into the braket folder. Confirm that the file was moved to the correct location by viewing the contacts of the folder, such as with the `dir` command in Windows.


If we have the below step #6, we don't need step #5 anymore.

Removed step to move the bellpair file to the virtual env.

avawang1 · 2020-01-28T20:07:10Z

README.md

@@ -160,38 +211,44 @@ With Amazon Braket, you can run your quantum circuit on a physical quantum compu
 The following example executes the same Bell Pair example described to validate your configuration against an IonQ quantum computer.


IonQ -> Rigetti

* update to readme reworking steps to resolve some issues on Mac * Update to update installation steps Changed to remove Conda and download repo zip files instead of configure SSH * update to readme Clean up to remove Conda, misc formatting * update to readme Formatting change * Update README.md * Update README.md addressing feedback from Ava * Update README.md added a note about jobs taking up to 24 hours on IonQ * Update README.md modified descriptions of simulators. * Update README.md Removed step to move the bellpair file to the virtual env.

* Update to README (#20) * Update to README Restructure content to move prereqs to a common section. Copy edit pass for style and language. Formatting changes for hierarchy and organization. * Update readme for private beta Multiple changes throughout to clarify steps to configure one's environment for the beta release. * Update to readme Addressed feedback, corrected a couple of format issues, removed step to create a kernel to simplify. * update to readme Added additional content for using a qpu, incorporated feedback. * restoring section on using a virtenv * update to readme (#23) * update to readme reworking steps to resolve some issues on Mac * Update to update installation steps Changed to remove Conda and download repo zip files instead of configure SSH * update to readme Clean up to remove Conda, misc formatting * update to readme Formatting change * Update README.md * Update README.md addressing feedback from Ava * Update README.md added a note about jobs taking up to 24 hours on IonQ * Update README.md modified descriptions of simulators. * Update README.md Removed step to move the bellpair file to the virtual env. * Update README.md * Update README.md * Update README.md * Update to section on creating resources Included a note in the section about creating resources for Amazon Braket to indicate that the template should be used only once per AWS account. * Update README.md * Add note about using stable branch * Update README.md added a note about how to remain anonymous when interacting with this repository * updating strings for documentation * resolving lint errors * Update README.md * all errors resolved, docs build * Add Bell state example (#39) * Added bell example * Changed example in README * Correct typos, outdated docstring Co-authored-by: randalld-aws <[email protected]> Co-authored-by: Ava Wang <[email protected]>

* Update to README (#20) * Update to README Restructure content to move prereqs to a common section. Copy edit pass for style and language. Formatting changes for hierarchy and organization. * Update readme for private beta Multiple changes throughout to clarify steps to configure one's environment for the beta release. * Update to readme Addressed feedback, corrected a couple of format issues, removed step to create a kernel to simplify. * update to readme Added additional content for using a qpu, incorporated feedback. * restoring section on using a virtenv * update to readme (#23) * update to readme reworking steps to resolve some issues on Mac * Update to update installation steps Changed to remove Conda and download repo zip files instead of configure SSH * update to readme Clean up to remove Conda, misc formatting * update to readme Formatting change * Update README.md * Update README.md addressing feedback from Ava * Update README.md added a note about jobs taking up to 24 hours on IonQ * Update README.md modified descriptions of simulators. * Update README.md Removed step to move the bellpair file to the virtual env. * Update README.md * Update README.md * Update README.md * Update to section on creating resources Included a note in the section about creating resources for Amazon Braket to indicate that the template should be used only once per AWS account. * Update README.md * Add note about using stable branch * Update README.md added a note about how to remain anonymous when interacting with this repository * Update README.md * Add Bell state example (#39) * Added bell example * Changed example in README * Update README.md updated steps to generate the html documentations for the SDK Co-authored-by: randalld-aws <[email protected]> Co-authored-by: Cody Wang <[email protected]>

randalld-aws added 4 commits January 27, 2020 18:04

update to readme

9cc1170

reworking steps to resolve some issues on Mac

Update to update installation steps

b3c9916

Changed to remove Conda and download repo zip files instead of configure SSH

update to readme

ff20f80

Clean up to remove Conda, misc formatting

update to readme

23942c4

Formatting change

avawang1 reviewed Jan 28, 2020

View reviewed changes

randalld-aws added 4 commits January 28, 2020 11:00

Update README.md

202af42

Update README.md

b791fdd

addressing feedback from Ava

Update README.md

acc99cb

added a note about jobs taking up to 24 hours on IonQ

Update README.md

59cc8d9

modified descriptions of simulators.

avawang1 reviewed Jan 28, 2020

View reviewed changes

Update README.md

3f1b7f4

Removed step to move the bellpair file to the virtual env.

randalld-aws merged commit 4bcd71e into master Jan 28, 2020

randalld-aws deleted the randalld-aws-patch branch January 28, 2020 20:03

avawang1 reviewed Jan 28, 2020

View reviewed changes

shiyunon pushed a commit to shiyunon/amazon-braket-sdk-python that referenced this pull request Mar 9, 2021

Added Rigetti metadata field to additional metadata (amazon-braket#23)

321651a

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

update to readme #23

update to readme #23

randalld-aws commented Jan 28, 2020

avawang1 Jan 28, 2020

randalld-aws Jan 28, 2020

avawang1 Jan 28, 2020

randalld-aws Jan 28, 2020

avawang1 Jan 28, 2020

avawang1 Jan 28, 2020

randalld-aws Jan 28, 2020

avawang1 Jan 28, 2020

avawang1 Jan 28, 2020

randalld-aws Jan 28, 2020

avawang1 Jan 28, 2020

avawang1 Jan 28, 2020

randalld-aws Jan 28, 2020

avawang1 Jan 28, 2020

avawang1 Jan 28, 2020

avawang1 Jan 28, 2020

		@@ -160,38 +211,44 @@ With Amazon Braket, you can run your quantum circuit on a physical quantum compu
		The following example executes the same Bell Pair example described to validate your configuration against an IonQ quantum computer.

update to readme #23

update to readme #23

Conversation

randalld-aws commented Jan 28, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment