Skip to content

Commit

Permalink
Links fixes in main project files (#112)
Browse files Browse the repository at this point in the history
* Fixed links with new repo URL
  • Loading branch information
ValentinS4t1qbit authored Jan 14, 2022
1 parent 064f5ea commit 624bff7
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 19 deletions.
16 changes: 8 additions & 8 deletions CONTRIBUTIONS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Thank you very much for considering contributing to this project; we’d love to

Do not feel intimidated by the guidelines and processes we describe in this document: we are here to assist you and help you take things to the finish line. We do not expect you to be an expert in software development or to get everything right on the first attempt: don’t hesitate to open an issue or a pull request, or simply contact us.

Contributors have various backgounds and experience, from high schoolers to fully fledged quantum scientists or chemists, and there are many ways you can contribute to this project. You can of course open a pull request (PR) and extend our codebase, but opening an issue to suggest a new feature, report a bug, improve our documentation or make a Jupyter notebook is just as valuable.
Contributors have various backgounds and experience, from high schoolers to fully fledged quantum scientists or chemists, and there are many ways you can contribute to this project. You can of course open a pull request (PR) and extend our codebase, but opening an issue to suggest a new feature, report a bug, improve our documentation or make a tutorial notebook is just as valuable.

By joining the Tangelo community and sharing your ideas and developments, you are creating an opportunity for us to learn and grow together, and take ideas to the finish line and beyond.

Expand All @@ -27,22 +27,22 @@ All submissions to the Github repository are subject to review by qualified proj

**1. Set up your fork**

Go to the `main Tangelo repo <https://github.com/quantumsimulation/QEMIST_qSDK>`_ and click the Fork button in the upper right corner of the screen.
This creates a new Github repo ``https://github.com/USERNAME/tangelo`` where ``USERNAME`` is your Github ID.
Go to the `main Tangelo repo <https://github.com/goodchemistryco/Tangelo>`_ and click the Fork button in the upper right corner of the screen.
This creates a new Github repo ``https://github.com/USERNAME/Tangelo`` where ``USERNAME`` is your Github ID.

In your terminal, clone the repo on your local machine, and move into the newly created directory:
In your terminal, clone the repo on your local machine, and move into the newly created directory (replace ``USERNAME`` with your user ID)

.. code-block:: shell
git clone https://github.com/quantumsimulation/QEMIST_qSDK.git
cd QEMISK_qSDK
git clone https://github.com/USERNAME/Tangelo.git
cd Tangelo
From the perspective of your local clone, your fork is called the ``origin`` remote.
Let's synchronize your fork with the main Tangelo repo by adding the latter as the upstream remote, and then update your local ``main`` branch:

.. code-block:: shell
git remote add upstream https://github.com/quantumsimulation/QEMIST_qSDK.git
git remote add upstream https://github.com/goodchemistryco/Tangelo.git
git fetch upstream
git checkout main
Expand All @@ -67,7 +67,7 @@ Let's assume you've made some changes and committed them with ``git commit``, an
**3. The Pull Request (PR)**

Now when you go to https://github.com/quantumsimulation/QEMIST_qSDK, you should be able to create a pull request from the branch on your fork to a branch on the main Tangelo repo. Give your pull request a name and briefly describe what the purpose is and include a reference to the associated issue if there's one.
Now when you go to https://github.com/goodchemistryco/Tangelo, you should be able to create a pull request from the branch on your fork to a branch on the main Tangelo repo. Give your pull request a name and briefly describe what the purpose is and include a reference to the associated issue if there's one.
Several Tangelo users will receive a notification, and will review your code and leave comments in the PR. You can reply to these comments, or simply apply the recommended changes locally, and then commit and push them like above: it automatically updates your PR.
If there are conflicts, you can solve them locally and push, or directly through Github.

Expand Down
16 changes: 9 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,18 @@ Tangelo overview
|dev_branch|

.. |maintainer| image:: https://img.shields.io/badge/Maintainer-GoodChemistry-blue
:target: https://goodchemistry.com
.. |licence| image:: https://img.shields.io/badge/License-Apache_2.0-green
:target: https://github.com/quantumsimulation/QEMIST_qSDK/blob/main/README.rst
.. |build| image:: https://github.com/quantumsimulation/QEMIST_qSDK/actions/workflows/continuous_integration.yml/badge.svg
:target: https://github.com/goodchemistryco/Tangelo/blob/main/LICENSE
.. |build| image:: https://github.com/goodchemistryco/Tangelo/actions/workflows/continuous_integration.yml/badge.svg
:target: https://github.com/goodchemistryco/Tangelo/actions/workflows/continuous_integration.yml
.. |dev_branch| image:: https://img.shields.io/badge/DevBranch-staging_0.3.0-yellow


Welcome !

Tangelo is an open-source python package developed by Good Chemistry Company, focused on the development of end-to-end material simulation workflows on quantum computers. Its modular design and ease-of-use enables users to easily assemble custom workflows, tinker and define their own building blocks, while keeping track of quantum resource requirements, such as number of qubits, gates or measurements. Through problem decomposition techniques, users can scale up beyond toy models and study the impact of quantum computing on more industrially-relevant use cases. Tangelo is backend-agnostic and compatible with many existing open-source frameworks, making the integration of third-party tools such as state-of-the-art simulators, circuit compilers or quantum cloud services straightforward. It is our wish to develop a community around Tangelo, collaborate, and together leverage the best of what the field has to offer.
Tangelo is an open-source python package developed by `Good Chemistry Company <https://goodchemistry.com>`_, focusing on the development of end-to-end material simulation workflows on quantum computers.

Its modular design and ease-of-use enables users to easily assemble custom workflows, tinker and define their own building blocks, while keeping track of quantum resource requirements, such as number of qubits, gates or measurements. Through problem decomposition techniques, users can scale up beyond toy models and study the impact of quantum computing on more industrially-relevant use cases. Tangelo is backend-agnostic and compatible with many existing open-source frameworks, making the integration of third-party tools such as state-of-the-art simulators, circuit compilers or quantum cloud services straightforward. It is our wish to develop a community around Tangelo, collaborate, and together leverage the best of what the field has to offer.


Install
Expand Down Expand Up @@ -82,8 +85,7 @@ TODO: insert sentence and link to sphinx documentation when its online.
Tutorials
---------

Please check the ``examples`` folder jupyter notebook tutorials and other examples.

Please check the ``examples`` folder for jupyter notebook tutorials and other examples.

Tests
-----
Expand All @@ -108,4 +110,4 @@ If you use Tangelo in your research, please cite

[TODO: this is a placeholder for our Tangelo paper, to be written and put on arxiv in October]

Copyright Good Chemistry Company 2021. This software is released under the Apache Software License version 2.0.
© Good Chemistry Company 2021. This software is released under the Apache Software License version 2.0.
8 changes: 4 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ def install(package):
setuptools.setup(
name="tangelo",
author="The Tangelo developers",
version="0.2.0",
description="Open-source quantum SDK developed for exploring quantum chemistry simulation end-to-end workflows on "
"gate-model quantum computers",
version="0.3.0",
description="Tangelo is a python package developed by Good Chemistry Company, focusing on the development "
"of end-to-end materials simulation workflows on quantum computers.",
long_description=long_description,
long_description_content_type="text/x-rst",
url="https://github.com/quantumsimulation/QEMIST_Tangelo",
url="https://github.com/goodchemistryco/Tangelo",
packages=setuptools.find_packages(),
test_suite="tangelo",
setup_requires=['h5py'],
Expand Down

0 comments on commit 624bff7

Please sign in to comment.