Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Repository base architecture #1

Merged
merged 25 commits into from
Oct 7, 2021
Merged

Repository base architecture #1

merged 25 commits into from
Oct 7, 2021

Conversation

gcattan
Copy link
Collaborator

@gcattan gcattan commented Sep 25, 2021

Issue:
pyRiemann/pyRiemann#141

This PR provides the architecture repository, with an updated list of references.
Implementation of the Qiskit wrapper will be raised in another PR for the purpose of clarity.

@gcattan gcattan changed the title Qiskit wrapper and repository architecture Repository base architecture Sep 25, 2021
This was referenced Sep 25, 2021
doc/index.rst Outdated Show resolved Hide resolved
doc/installing.rst Outdated Show resolved Hide resolved
@sylvchev
Copy link
Member

Good idea to separate the base from the code wrapper.

doc/conf.py Outdated Show resolved Hide resolved
doc/index.rst Outdated Show resolved Hide resolved
doc/index.rst Outdated Show resolved Hide resolved
doc/installing.rst Outdated Show resolved Hide resolved
doc/introduction.rst Outdated Show resolved Hide resolved
setup.py Outdated
Comment on lines 22 to 24
url='https://pyriemann.readthedocs.io',
author='Alexandre Barachant',
author_email='alexandre.barachant@gmail.com',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Must be updated.

Copy link
Collaborator Author

@gcattan gcattan Sep 27, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure. Can you please tell me how to deploy the docs once the artifact is generated, and if I should reserve the url name and to which provisioner?
Please, confirm also the name of the authors and how it is suitable to give credit for your work.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sylvchev , can you test the documentation deployment?

@@ -0,0 +1,200 @@
import pytest
Copy link
Member

@qbarthelemy qbarthelemy Sep 27, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of a copy-paste this file from pyRiemann, is it possible to import conftest from pyRiemann dependency (for example, with from pyriemann.tests import conftest)? @sylvchev

gcattan and others added 10 commits September 27, 2021 22:27
Co-authored-by: Quentin Barthélemy <q.barthelemy@gmail.com>
Co-authored-by: Quentin Barthélemy <q.barthelemy@gmail.com>
Co-authored-by: Quentin Barthélemy <q.barthelemy@gmail.com>
add link to issue in the example gallery
- update conf pyRiemann -> pyRiemann-qiskit
- remove example in index (as not yet available)
@gcattan
Copy link
Collaborator Author

gcattan commented Sep 28, 2021

@sylvchev @qbarthelemy thanks for your valuable comments and suggestion.

I updated the documentation and opened issue #4 to update the documentation with example and API reference once #2 is reviewed.

You can download the last documentation build from this link:

https://github.com/gcattan/pyRiemann-qiskit/actions/runs/1281835577

I did not address yet the conftest related problem as waiting for inputs.

doc/index.rst Outdated Show resolved Hide resolved
doc/whatsnew.rst Outdated Show resolved Hide resolved
gcattan and others added 4 commits September 29, 2021 11:44
Co-authored-by: Quentin Barthélemy <q.barthelemy@gmail.com>
Co-authored-by: Quentin Barthélemy <q.barthelemy@gmail.com>
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
doc/introduction.rst Outdated Show resolved Hide resolved
doc/index.rst Outdated Show resolved Hide resolved
gcattan and others added 3 commits September 30, 2021 12:41
Co-authored-by: Quentin Barthélemy <q.barthelemy@gmail.com>
Co-authored-by: Quentin Barthélemy <q.barthelemy@gmail.com>
Co-authored-by: Quentin Barthélemy <q.barthelemy@gmail.com>
@gcattan
Copy link
Collaborator Author

gcattan commented Sep 30, 2021

@qbarthelemy Thank you for your comments and for providing edit suggestions.

Copy link
Member

@qbarthelemy qbarthelemy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's OK for me.
I let @sylvchev approve and squash+merge.

@sylvchev
Copy link
Member

sylvchev commented Oct 7, 2021

Nice work!

@sylvchev sylvchev merged commit a6107f8 into pyRiemann:main Oct 7, 2021
@gcattan gcattan deleted the gc/base branch November 19, 2021 14:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants