Big Bang

Author: Mandrenkov

.github/CHANGELOG.md

@@ -0,0 +1,11 @@
+## Release 0.1.0
+
+### New features since last release
+
+* This is the initial public release.
+
+### Contributors
+
+This release contains contributions from (in alphabetical order):
+
+[Mikhail Andrenkov](https://github.com/Mandrenkov), [Jack Brown](https://github.com/brownj85), [Lee J. O'Riordan](https://github.com/mlxd), [Trevor Vincent](https://github.com/trevor-vincent).

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

.github/CONTRIBUTING.md

@@ -0,0 +1,154 @@
+# Contributing to Jet
+
+Thank you for taking the time to contribute to Jet!
+:airplane: :confetti_ball: :tada: :fireworks: :balloon:
+
+Jet is a collaborative effort with the quantum computation community - while we
+will continue working on adding new and exciting features to Jet, we invite you
+to join us and suggest improvements, research ideas, or even just to discuss how
+Jet fits into your workflow.
+
+## How can I get involved in the community?
+
+If you want to contribute but don't know where to start, check out our
+[documentation](https://quantum-jet.readthedocs.io) and have a go at working
+through some of the tutorials.  Afterwards, take a look at the Jet API to see
+how things work under the hood.
+
+## How can I contribute?
+
+It's up to you!
+
+* **Be a part of our community** - provide exciting updates of the projects or
+  experiments you are investigating with Jet.
+
+  You can even write your own Jet tutorials, or blog about your simulation results.
+  Send us the link, and we may even add it to our documentation as an external
+  resource!
+
+* **Test the cutting-edge Jet releases** - clone our GitHub repository, and keep
+  up to date with the latest features. If you run into any bugs, make a bug
+  report on our [issue tracker](https://github.com/XanaduAI/jet/issues).
+
+* **Report bugs** - even if you are not using the development branch of Jet, if
+  you come across any bugs or issues, make a bug report. See the next section
+  for more details on the bug reporting procedure.
+
+* **Suggest new features and enhancements** - use the GitHub issue tracker and
+  let us know what will make Jet even better for your workflow.
+
+* **Contribute to our documentation, or to Jet directly** - we are hoping for
+  our documentation to become an online, open-source resource for all things
+  tensor. If you would like to add to it, or suggest improvements/changes, let
+  us know - or even submit a pull request directly. All authors who have
+  contributed to the Jet codebase will be listed alongside the latest release.
+
+* **Build an application on top of Jet** - have an idea for an application, and
+  Jet provides the perfect computational backbone? Consider making a fully
+  separate app that builds upon Jet as a base. Ask us if you have any questions,
+  and send a link to your application to [email protected] so we can highlight
+  it in our documentation!
+
+Appetite whetted? Keep reading below for all the nitty-gritty on reporting bugs,
+contributing to the documentation, and submitting pull requests.
+
+## Reporting bugs
+
+We use the [GitHub issue tracker](https://github.com/XanaduAI/jet/issues) to
+keep track of all reported bugs and issues. If you find a bug, or have an issue
+with Jet, please submit a bug report! User reports help us make Jet better on
+all fronts.
+
+To submit a bug report, please work your way through the following checklist:
+
+* **Search the issue tracker to make sure the bug wasn't previously reported**.
+  If it was, you can add a comment to expand on the issue and share your
+  experience.
+
+* **Fill out the issue template**. If you cannot find an existing issue
+  addressing the problem, create a new issue by filling out the
+  [bug issue template](./ISSUE_TEMPLATE/BUG.md). This template is added
+  automatically to the comment box when you create a new issue. Please try and
+  add as many details as possible!
+
+* Try and make your issue as **clear, concise, and descriptive** as possible.
+  Include a clear and descriptive title, and include all code snippets and
+  commands required to reproduce the problem. If you're not sure what caused the
+  issue, describe what you were doing when the issue occurred.
+
+## Suggesting features, document additions, and enhancements
+
+To suggest features and enhancements, use the GitHub tracker.  No template is
+required for feature requests and enhancements, but here are a couple of
+suggestions for things to include:
+
+* **Use a clear and descriptive title**
+* **Provide a step-by-step description of the suggested feature**.
+
+  - If the feature is related to any theoretical results in quantum computation,
+    provide any relevant equations. Alternatively, provide references to
+    papers or preprints with the relevant sections and equations noted.
+  - If the feature is workflow-related, or related to the use of Jet, explain
+    why the enhancement would be useful and where/how you would like to use it.
+
+* **For documentation additions**, point us towards any relevant equations,
+    papers, and preprints with the relevant sections and equations noted. Short
+    descriptions of its use and importance would also be helpful.
+
+## Pull requests
+
+If you would like to contribute directly to the Jet codebase, simply make a
+fork of the main branch and submit a
+[pull request](https://help.github.com/articles/about-pull-requests). We
+encourage everyone to have a go forking and modifying the Jet source code;
+however, we have a couple of guidelines on pull requests to ensure the main
+branch conforms to existing standards and quality.
+
+### General guidelines
+
+* **Do not make a pull request for minor typos/cosmetic code changes** - create
+  an issue instead.
+* **For major features, consider making an independent application** that runs
+  on top of Jet, rather than modifying Jet directly.
+
+### Before submitting
+
+Before submitting a pull request, please make sure the following is done:
+
+* **All new features must include a unit test.** If you've fixed a bug or added
+  code that should be tested, add a test to the [`test/`](test/) directory!
+* **All new classes, functions, and members must be clearly commented and documented**.
+  If you do make documentation changes, make sure that the docs build and render
+  correctly by running `make docs`.
+* **Ensure that the test suite passes.**  Verify that `make test` passes.
+* **Ensure that the modified code is formatted correctly.**  Verify that
+  `make format` passes.
+
+### Submitting the pull request
+* When ready, submit your fork as a
+  [pull request](https://help.github.com/articles/about-pull-requests) to the
+  Jet repository, filling out the
+  [pull request template](./PULL_REQUEST_TEMPLATE.md). This template is added
+  automatically to the comment box when you create a new PR.
+
+* When describing the pull request, please include as much detail as possible
+  regarding the changes made, new features, and performance improvements. If
+  including any bug fixes, mention the issue numbers associated with the bugs.
+
+* Once you have submitted the pull request, two things will automatically occur:
+
+  - The **test suite** will automatically run on
+    [CircleCI](https://app.circleci.com/pipelines/github/XanaduAI/jet) to ensure
+    that all tests continue to pass.
+
+  - The **formatter** will automatically run on
+    [CircleCI](https://app.circleci.com/pipelines/github/XanaduAI/jet) to ensure
+    that all the code is properly formatted.
+
+  Based on these results, we may ask you to make small changes to your branch
+  before merging the pull request into the main branch. Alternatively, you can
+  [grant us permission to make changes to your pull request branch](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/).
+
+:airplane: Thank you for contributing to Jet! :airplane:
+
+\- The Jet team

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,38 @@
+---
+name: Bug Report
+about: Submit a bug report.
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+#### Before posting an issue
+
+* Search existing GitHub issues to make sure the issue does not already exist: https://github.com/XanaduAI/jet/issues.
+
+* Delete everything above the dashed line and fill in the template.
+
+* For general technical details, check out our documentation: https://quantum-jet.readthedocs.io.
+
+-------------------------------------------------------------------------------------------------------------
+
+#### Bug description
+
+Description of the issue - include code snippets and screenshots here if relevant. You may use the following template below:
+
+* *Expected behavior:* (What you expect to happen)
+
+* *Actual behavior:* (What actually happens)
+
+* *Reproduces how often:* (Percentage of the time this issue reproduces)
+
+* *System information:* (Relevant compilation or execution environment details, including your operating system, compiler, Jet version, and linked libraries)
+
+#### Source code and backtraces
+
+Please include any additional code snippets and backtraces related to the issue here.
+
+#### Additional information
+
+Any additional information, configuration or data that might be necessary to reproduce the issue.

.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,30 @@
+---
+name: Feature Request
+about: Submit a feature request.
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+#### Before posting an issue
+
+* Search existing GitHub issues to make sure the issue does not already exist: https://github.com/XanaduAI/jet/issues.
+
+* Delete everything above the dashed line and describe, in detail, the feature and why it is needed.
+
+* For general technical details, check out our documentation: https://quantum-jet.readthedocs.io.
+
+-------------------------------------------------------------------------------------------------------------
+
+#### Feature description
+
+Description of the feature - include code snippets, documentation, or any other relevant details here.  Ideally, a feature request should read like a story and address the following points:
+
+* *Context:* What is the problem to be solved?
+
+* *Factors:* What should be taken into account by the implementation?
+
+* *Review:* What other projects have implemented this feature?
+
+* *Proposals:* What are the candidate solutions?

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,32 @@
+### Before submitting
+
+Please complete the following checklist when submitting a PR:
+
+- [ ] All new features must include a unit test. If you've fixed a bug or added
+      code that should be tested, add a test to the [`test/`](test/) directory!
+
+- [ ] All new classes, functions, and members must be clearly commented and
+      documented.  If you do make documentation changes, make sure that the docs
+      build and render correctly by running `make docs`.
+
+- [ ] Ensure that the test suite passes by running `make test`.
+
+- [ ] Ensure that code is properly formatted by running `make format`.
+
+- [ ] Add a new entry to [`CHANGELOG.MD`](.github/CHANGELOG.md), summarizing the
+      change and including a link back to the PR.
+
+When all the above are checked, delete everything above the dashed
+line and fill in the pull request template.
+
+------------------------------------------------------------------------------------------------------------
+
+**Context:**
+
+**Description of the Change:**
+
+**Benefits:**
+
+**Possible Drawbacks:**
+
+**Related GitHub Issues:**

.github/workflows/documentation.yml

@@ -0,0 +1,35 @@
+name: Documentation
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+    paths:
+      - "docs/**"
+      - "include/**"
+
+jobs:
+  build:
+    name: Build (HTML)
+    runs-on: ubuntu-20.04
+
+    steps:
+      - name: Cancel previous runs
+        uses: styfle/[email protected]
+        with:
+          access_token: ${{ github.token }}
+
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - uses: josh146/sphinx-action@master
+        with:
+          docs-folder: "docs/"
+          pre-build-command: "apt install -y doxygen && pip3 install -r requirements.txt"
+          build-command: "make html"
+
+      - name: Upload HTML
+        uses: actions/upload-artifact@v2
+        with:
+          name: html
+          path: docs/_build/html/

.github/workflows/format.yml

@@ -0,0 +1,29 @@
+name: Format
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+    paths:
+      - "include/**"
+      - "test/**"
+
+jobs:
+  format:
+    name: Format
+    runs-on: ubuntu-20.04
+
+    steps:
+      - name: Cancel previous runs
+        uses: styfle/[email protected]
+        with:
+          access_token: ${{ github.token }}
+
+      - name: Install dependencies
+        run: sudo apt update && sudo apt -y install clang-format python3
+
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Run formatter
+        run: ./bin/format --check include test