Share Your Quantum Algorithm

Join the quantum computing community by publishing your algorithms, research implementations, and educational resources on Polystacks - the open source hub for heterogeneous computing.

🚀How It Works

Add Polystacks Metadata to Your README

Include our YAML metadata block in your GitHub repository's README.md file. This helps us discover and categorize your algorithm correctly.

Add the "quantum-marqov" Topic

On your GitHub repository, add quantum-marqov as a repository topic.

Submit Your Repository

Use our submission form below to notify us. We'll review and index your algorithm within 48 hours.

📋Metadata Template

Add this YAML block to the top of your README.md file:

---
quantum-marqov:
  framework: qiskit  # Options: qiskit, cirq, pennylane, qsharp, braket, pytket
  task-type: optimization  # Options: optimization, ml, chemistry, cryptography, algorithms, simulation
  hardware:
    - ibm-quantum
    - simulator
  qubits: 4  # Number of qubits required
  license: MIT
  verified: false  # Set to true if you're an official organization
---

Framework Options:

qiskitcirqpennylaneqsharpbraketpytket

Task Type Options:

optimizationmlchemistrycryptographyalgorithmssimulation

Hardware Options:

ibm-quantumionqrigettixanadusimulatoraws-braketazure-quantum

📄Complete README Example

Here's a complete README.md template to get you started:

# Your Quantum Algorithm Name

[![Polystacks](https://img.shields.io/badge/polystacks-listed-green)](https://polystacks.dev)

## Description

A brief description of what your quantum algorithm does and why it's useful.

## Polystacks Metadata

```yaml
---
quantum-marqov:
  framework: qiskit  # Options: qiskit, cirq, pennylane, qsharp, braket, pytket
  task-type: optimization  # Options: optimization, ml, chemistry, cryptography, algorithms, simulation
  hardware:
    - ibm-quantum
    - simulator
  qubits: 4  # Number of qubits required
  license: MIT
  verified: false  # Set to true if you're an official organization
---
```

## Installation

```bash
pip install qiskit
```

## Usage

```python
from qiskit import QuantumCircuit

# Your algorithm code here
circuit = QuantumCircuit(2)
circuit.h(0)
circuit.cx(0, 1)
```

## Benchmarks

Performance metrics and results...

## Citation

If you use this algorithm in your research, please cite:

```bibtex
@article{yourpaper2024,
  title={Your Paper Title},
  author={Your Name},
  journal={arXiv preprint arXiv:2401.00000},
  year={2024}
}
```

## License

MIT License - see LICENSE file for details

🏷️Adding the GitHub Topic

To add the quantum-marqov topic to your repository:

Go to your repository on GitHub
Click the gear icon (⚙️) next to "About" in the sidebar
In the "Topics" field, type quantum-marqov
Press Enter to add the topic
Click "Save changes"

💡Pro tip: Add other relevant topics like your framework name (qiskit, cirq, etc.) and domain (quantum-computing, quantum-algorithms) to help more people discover your work!

📮Submit Your Algorithm

Once you've added the metadata and topic to your repository, submit it here for review:

Submit Algorithm via GitHub Issue

⏱️Review time: We review submissions within 48 hours. You'll receive a notification when your algorithm is live on the platform!

✅Requirements & Guidelines

Required:

✓Open source repository on GitHub
✓Valid Polystacks metadata in README
✓Working quantum algorithm implementation
✓Open source license (MIT, Apache 2.0, GPL, etc.)
✓Basic documentation (installation, usage)

Verified Badge Criteria:

Get a ⭐ Verified badge if you're:

⭐Official quantum computing framework (IBM, Google, Xanadu, etc.)
⭐Academic research lab with peer-reviewed publications
⭐Algorithm referenced in published research papers

❓Frequently Asked Questions

Do I need to host my code on Polystacks?

No! Your code stays on GitHub. We just index and showcase it, linking back to your repository.

Will my algorithm auto-update when I push changes?

Yes! Once indexed, we automatically sync your README and metadata daily. Stars, forks, and other GitHub metrics update in real-time.

Can I submit algorithms for educational purposes?

Absolutely! We welcome educational implementations, tutorials, and learning resources. Just make sure they're well-documented and functional.

What if my algorithm uses multiple frameworks?

List the primary framework in the metadata. Mention other frameworks in your README description.

Can I remove my algorithm later?

Yes! Simply remove the quantum-marqov topic from your GitHub repository, and it will be delisted within 24 hours.

Is there a cost to list my algorithm?

No, it's completely free! Marqov is a community platform for quantum computing.

Ready to Share Your Quantum Algorithm?

Join researchers and developers from IBM, Google, and leading universities in building the world's most comprehensive quantum computing hub.

Submit Algorithm Browse Algorithms