Conversation
# Conflicts: # nicompiler_backend/.gitignore # nicompiler_backend/Cargo.toml # nicompiler_backend/src/channel.rs # nicompiler_backend/src/device.rs # nicompiler_backend/src/experiment.rs # nicompiler_backend/src/instruction.rs # nicompiler_backend/src/lib.rs # nicompiler_backend/src/main.rs # nicompiler_backend/src/unittest.rs
…ced in `/py_api/nistreamer/_nistreamer`, updated config files and imports)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Re-organized codebase following
pyo3repo layoutMerged
base-streamerrepo back intonistreamerOriginally, codebase was split into separate
base-streamerandni-streamerrepos with the intent to potentially re-usebase-streamerlogic in similar streaming packages on other hardware platforms.However, when split into separate repos,
ni-streamerandbase-streamercan have different, possibly incompatible versions checked-out. This increases the risk of confusing errors when users are trying to build from source. There is also a room for maintainer overlooks and version scrambling.With this PR, we are releasing on PyPI, so clear and consistent version management becomes critical. Since extending to other hardware platforms is unlikely, we decided to merge
base-streamerback intonistreamerto lock both versions together.base-streameris left visible for reference.nistreamer-usrlibis still a separate repo to allow for user-managed forks.Unified naming convention
Changed crate naming convention (following
pyo3example):nistreamer-macrosnistreamer-basenistreamer-usrlibnistreamerUpdated GitHub repos. Also changed GitHub organization name from
pulse-streamertoNIStreamerfor clarity.Flattened sub-crate directory layout
Now the head crate
nistreameris the repo root. Secondary crates -nistreamer-macrosandnistreamer-base- are sub-directories placed in root.Maturin mixed Rust-Python project
Now
maturinrecognizes the project as mixed and handles Py API together with the compiled back-end:maturin developplaces compiled_nistreamerinto PyAPI directory and installs a link into the activeLib/site-packagessoimport nistreamerworks without adding path;maturin buildpacks both PyAPI and compiled_nistreamertogether into a wheel.PyPI Wheel
pyo3to allow for a single build to run on multiple Python versions;pyproject.toml.Docs
Getting Started/Installation;Internals/Project Structuresection.