quantum-cartpole

The quantum cartpole

https://github.com/condensedai/quantum-cartpole

Science Score: 57.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 5 DOI reference(s) in README
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (9.0%) to scientific vocabulary

Last synced: 7 months ago · JSON representation ·

Repository

The quantum cartpole

Basic Info

Host: GitHub
Owner: condensedAI
License: mit
Language: Python
Default Branch: main
Size: 309 KB

Statistics

Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Releases: 1

Created almost 4 years ago · Last pushed over 1 year ago

Metadata Files

Readme Citation

README.rst

Quantum Cartpole
=========

Introduction
------------

Python implementation of a quantum cartpole environment which can be used for benchmarking and developing of agents as outline in the `paper `_. The implementation adheres to the OpenAI Gym standard.

Under the MIT lisence.

Installation
------------

To get started with the Quantum Cartpole environment, you can install it by simply cloning this repository:

.. code-block:: bash

    git clone https://github.com/condensedAI/quantum-cartpole.git

Basic Usage
------------

The Quantum Cartpole environment can be used as follows. It offers a choice of three different potentials: quadratic, cosine, and quartic, and can be switched between classical and quantum environment.

.. code-block:: bash

        import gym
        import gym_qcart
        env = gym.make('qcart-v0', potential = 'quadratic', system = 'quantum')

To run examples for training and testing the agents, you can use the following commands:

For training with a quadratic potential:

.. code-block:: bash
    
    python -m example.train


For testing:

.. code-block:: bash

    python -m example.test quadratic


Reference
---------

When you cite this repository, please use the following:

.. code-block:: bibtex

  @software{meinerz_2023_10060570,
    author       = {Meinerz, Kai},
    title        = {Quantum cartpole environment},
    month        = nov,
    year         = 2023,
    publisher    = {Zenodo},
    version      = {v0.1.0},
    doi          = {10.5281/zenodo.10060570},
    url          = {https://doi.org/10.5281/zenodo.10060570}
  }

Owner

Name: condensedAI
Login: condensedAI
Kind: organization

Repositories: 2
Profile: https://github.com/condensedAI

Citation (CITATION.cff)

cff-version: 1.2.0
title: Quantum cartpole environment
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Kai
    family-names: Meinerz
    orcid: 'https://orcid.org/0000-0002-9141-7113'
    email: kmeinerz@thp.uni-koeln.de
    affiliation: >-
      Institute for Theoretical Physics, University of
      Cologne, 50937 Cologne, Germany
repository-code: 'https://github.com/condensedAI/quantum-cartpole'
date-released: 2023-08-21

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science