Compare commits
No commits in common. "main" and "feature-quackseq" have entirely different histories.
main
...
feature-qu
4 changed files with 18 additions and 19 deletions
|
@ -1,9 +1,5 @@
|
|||
# Changelog
|
||||
|
||||
## Version 0.0.13 (19-06-2025)
|
||||
|
||||
- Change to quackseq pulseprogramming framework (`47c442ca84f3691091983cf31866888689864f3b`)
|
||||
|
||||
## Version 0.0.12 (27-05-2024)
|
||||
|
||||
- Implemented loading and saving of settings and default settings (`6496ec6824da33fa41a38e26fdcac9a03ceb51fb`)
|
||||
|
|
10
README.md
10
README.md
|
@ -1,6 +1,6 @@
|
|||
# NQRduck Module: nqrduck-spectrometer
|
||||
|
||||
A module for the [nqrduck](https://git.private.coffee/nqrduck/nqrduck) project. This module is used as a base module for implementing different spectrometers. It provides the basic functionality for controlling a spectrometer and programming pulse sequences.
|
||||
A module for the [nqrduck](https://github.com/nqrduck/nqrduck) project. This module is used as a base module for implementing different spectrometers. It provides the basic functionality for controlling a spectrometer and programming pulse sequences.
|
||||
|
||||
## Installation
|
||||
|
||||
|
@ -8,7 +8,7 @@ A module for the [nqrduck](https://git.private.coffee/nqrduck/nqrduck) project.
|
|||
Dependencies are handled via the pyproject.toml file.
|
||||
|
||||
### Setup
|
||||
To install the module you need the NQRduck core. You can find the installation instructions for the NQRduck core [here](https://git.private.coffee/nqrduck/nqrduck).
|
||||
To install the module you need the NQRduck core. You can find the installation instructions for the NQRduck core [here](https://github.com/nqrduck/nqrduck).
|
||||
|
||||
Ideally you should install the module in a virtual environment. You can create a virtual environment by running the following command in the terminal:
|
||||
```bash
|
||||
|
@ -25,11 +25,11 @@ pip install .
|
|||
## Usage
|
||||
Examples for implementation of submodules can be found in the following repositories:
|
||||
|
||||
- [nqrduck-spectrometer-limenqr](https://git.private.coffee/nqrduck/nqrduck-spectrometer-limenqr) A module used for magnetic resonance experiments with the LimeSDR (USB or Mini 2.0).
|
||||
- [nqrduck-spectrometer-simulator](https://git.private.coffee/nqrduck/nqrduck-spectrometer-simulator) A module used for simulating magnetic resonance experiments.
|
||||
- [nqrduck-spectrometer-limenqr](https://github.com/nqrduck/nqrduck-spectrometer-limenqr) A module used for magnetic resonance experiments with the LimeSDR (USB or Mini 2.0).
|
||||
- [nqrduck-spectrometer-simulator](https://github.com/nqrduck/nqrduck-spectrometer-simulator) A module used for simulating magnetic resonance experiments.
|
||||
|
||||
## License
|
||||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
|
||||
|
||||
## Contributing
|
||||
If you're interested in contributing to the project, start by checking out our [nqrduck-module template](https://git.private.coffee/nqrduck/nqrduck-module). To contribute to existing modules, please first open an issue in the respective module repository to discuss your ideas or report bugs.
|
||||
If you're interested in contributing to the project, start by checking out our [nqrduck-module template](https://github.com/nqrduck/nqrduck-module). To contribute to existing modules, please first open an issue in the respective module repository to discuss your ideas or report bugs.
|
||||
|
|
|
@ -15,7 +15,6 @@ jobs:
|
|||
# uses: ./.github/workflows/ubuntu-python-package.yml # use the callable tests job to run tests
|
||||
|
||||
deploy:
|
||||
runs-on: docker
|
||||
|
||||
container:
|
||||
image: node:22-bookworm
|
||||
|
@ -23,20 +22,24 @@ jobs:
|
|||
# needs: [test]
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v3
|
||||
with:
|
||||
python-version: "3.11"
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
apt update
|
||||
apt install -y python3 python3-venv python3-pip
|
||||
sudo apt-get update
|
||||
python -m pip install --upgrade pip
|
||||
|
||||
- name: Publish to PyPI
|
||||
run: |
|
||||
python3 -m venv venv
|
||||
python -m venv venv
|
||||
. ./venv/bin/activate
|
||||
python3 -m pip install --upgrade pip
|
||||
pip install -U twine build
|
||||
python -m build .
|
||||
python -m twine upload --repository pypi --username __token__ --password ${{ secrets.PYPI }} dist/*
|
||||
env:
|
||||
PYPI: ${{ secrets.PYPI }}
|
||||
PYPI: ${{ secrets.PYPI }}
|
|
@ -7,7 +7,7 @@ allow-direct-references = true
|
|||
|
||||
[project]
|
||||
name = "nqrduck-spectrometer"
|
||||
version = "0.0.13"
|
||||
version = "0.0.12"
|
||||
authors = [
|
||||
{ name="jupfi", email="support@nqruck.cool" },
|
||||
]
|
||||
|
@ -61,8 +61,8 @@ convention = "google"
|
|||
|
||||
[project.urls]
|
||||
"Homepage" = "https://nqrduck.cool"
|
||||
"Bug Tracker" = "https://git.private.coffee/nqrduck/nqrduck-spectrometer/issues"
|
||||
"Source Code" = "https://git.private.coffee/nqrduck/nqrduck-spectrometer"
|
||||
"Bug Tracker" = "https://github.com/nqrduck/nqrduck-spectrometer/issues"
|
||||
"Source Code" = "https://github.com/nqrduck/nqrduck-spectrometer"
|
||||
|
||||
[tool.hatch.build.targets.wheel]
|
||||
packages = ["src/nqrduck_spectrometer"]
|
Loading…
Add table
Add a link
Reference in a new issue