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

✨ Allow project installation #529

Merged
merged 8 commits into from
Jan 12, 2024
Merged

✨ Allow project installation #529

merged 8 commits into from
Jan 12, 2024

Conversation

burgholzer
Copy link
Member

@burgholzer burgholzer commented Jan 12, 2024

Description

This PR sets up the project so that it can be installed properly.
As it is configured right now, this allows to install the mqt-core Python package and make the C++ project available via find_package(mqt-core) as long as the proper cmake directory is added to the search path.
The right directory can easily be determined via python -m mqt.core --cmake_dir (or via mqt-core-cli --cmake_dir).
You might be wondering what this is useful for. It allows us to only require a single source copy of mqt-core in top-level projects once we switch them to using the mqt-core Python package. Otherwise, we would need to maintain the submodule and the Python package in parallel.

While I expect this to require some follow ups once used in practice, I believe this is a solid start.

Fixes #504

Checklist:

  • The pull request only contains commits that are related to it.
  • I have added appropriate tests and documentation.
  • I have made sure that all CI jobs on GitHub pass.
  • The pull request introduces no new warnings and follows the project's style guidelines.

Signed-off-by: burgholzer <burgholzer@me.com>
@burgholzer burgholzer added feature New feature or request minor Minor version update Core Anything related to the Core library and IR packaging Anything related to Python packaging labels Jan 12, 2024
@burgholzer burgholzer added this to the MQT Core milestone Jan 12, 2024
@burgholzer burgholzer self-assigned this Jan 12, 2024
Copy link

codecov bot commented Jan 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (f450d97) 91.3% compared to head (7ff1c87) 91.3%.

Additional details and impacted files

Impacted file tree graph

@@          Coverage Diff          @@
##            main    #529   +/-   ##
=====================================
  Coverage   91.3%   91.3%           
=====================================
  Files        128     130    +2     
  Lines      13805   13851   +46     
  Branches    2151    2151           
=====================================
+ Hits       12609   12655   +46     
  Misses      1196    1196           
Flag Coverage Δ
cpp 91.0% <ø> (ø)
python 99.7% <100.0%> (+<0.1%) ⬆️
Files Coverage Δ
src/mqt/core/__init__.py 100.0% <100.0%> (ø)
src/mqt/core/__main__.py 100.0% <100.0%> (ø)
src/mqt/core/commands.py 100.0% <100.0%> (ø)

Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
@burgholzer burgholzer enabled auto-merge (squash) January 12, 2024 14:56
Signed-off-by: burgholzer <burgholzer@me.com>
@burgholzer burgholzer merged commit c2ed211 into main Jan 12, 2024
34 checks passed
@burgholzer burgholzer deleted the project-installation branch January 12, 2024 15:42
This was referenced Jan 12, 2024
burgholzer added a commit that referenced this pull request Jan 13, 2024
## Description

This PR fixes a small oversight in #529 where one of the install
instructions was not guarded properly. This should fix the issues
observed in cda-tum/mqt-qcec#352.

## Checklist:

<!---
This checklist serves as a reminder of a couple of things that ensure
your pull request will be merged swiftly.
-->

- [x] The pull request only contains commits that are related to it.
- [x] I have added appropriate tests and documentation.
- [x] I have made sure that all CI jobs on GitHub pass.
- [x] The pull request introduces no new warnings and follows the
project's style guidelines.

Signed-off-by: burgholzer <burgholzer@me.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Core Anything related to the Core library and IR feature New feature or request minor Minor version update packaging Anything related to Python packaging
Projects
Status: Done
Status: Done
Development

Successfully merging this pull request may close these issues.

The project doesn't install anything
1 participant