Skip to content

Commit

Permalink
update readme and contributing now that we don't have paper code
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinsung committed Mar 18, 2024
1 parent 69145de commit 0430a39
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 18 deletions.
13 changes: 0 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,6 @@ Users are encouraged to use GitHub issues for reporting issues and requesting fe

All submissions require review. To make a submission, open a GitHub pull request.

## Submitting a new research experiment

You can submit an experiment if it satisfies the following requirements:

- It is programmed using Qiskit.
- It is executed on quantum hardware.
- There is an associated publication or publicly available preprint describing the results from running the experiment.

To submit a new research experiment:

1. Create a new module for your experiment under the [`qiskit_research`](qiskit_research/) base module.
2. Create a new directory under [docs/](docs/) and add Jupyter notebooks to document your experiment.

## Running tests locally

The tests can be run locally using [tox](https://tox.wiki/en/latest/).
Expand Down
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# Qiskit Research

Research using Qiskit.

This repository contains modules for running quantum computing research experiments
using Qiskit and the IBM Quantum Services, demonstrating by example best practices
for running such experiments.
This repository contains useful software utilities for running quantum computing research experiments using Qiskit and the IBM Quantum Services.

## Installation

Expand All @@ -27,3 +23,11 @@ For information on how to contribute to this project, please take a look at our
[![DOI](https://zenodo.org/badge/498756635.svg)](https://zenodo.org/badge/latestdoi/498756635)

Qiskit Research is automatically uploaded to Zenodo with every release. Click the badge above to see all citation formats for all versions, or just use [this BibTeX file](CITATION.bib).

## Moved content

Previously, this repository also contained the code for several research papers that used Qiskit and the IBM Quantum Services. The code for these papers has moved to the following locations:

- Majorana zero mode generation: <https://github.com/qiskit-community/mzm-generation>
- Protein folding: <https://github.com/qiskit-community/quantum-protein-folding>
- Quantum simulation tutorial: <https://github.com/qiskit-community/tutorial-quantum-sim>

0 comments on commit 0430a39

Please sign in to comment.