Change to forgejo.
This commit is contained in:
parent
b5d5559cfb
commit
fd8be8460f
3 changed files with 18 additions and 21 deletions
|
@ -15,30 +15,27 @@ jobs:
|
|||
# uses: ./.github/workflows/ubuntu-python-package.yml # use the callable tests job to run tests
|
||||
|
||||
deploy:
|
||||
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: docker
|
||||
container:
|
||||
image: node:22-bookworm
|
||||
|
||||
# needs: [test]
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v3
|
||||
with:
|
||||
python-version: "3.11"
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
sudo apt-get update
|
||||
python -m pip install --upgrade pip
|
||||
apt update
|
||||
apt install -y python3 python3-venv python3-pip
|
||||
|
||||
- name: Publish to PyPI
|
||||
run: |
|
||||
python -m venv venv
|
||||
python3 -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 }}
|
14
README.md
14
README.md
|
@ -1,6 +1,6 @@
|
|||
# NQRduck Module: nqrduck-measurement
|
||||
|
||||
A module for the [nqrduck](https://github.com/nqrduck/nqrduck) project. This module is used for single frequency magnetic resonance experiments.
|
||||
A module for the [nqrduck](https://git.private.coffee/nqrduck/nqrduck) project. This module is used for single frequency magnetic resonance experiments.
|
||||
|
||||
## Installation
|
||||
|
||||
|
@ -10,7 +10,7 @@ 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://github.com/nqrduck/nqrduck).
|
||||
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).
|
||||
|
||||
Ideally you should install the module in a virtual environment. You can create a virtual environment by running the following command in the terminal:
|
||||
|
||||
|
@ -34,14 +34,14 @@ pip install nqrduck-measurement
|
|||
|
||||
## Usage
|
||||
|
||||
The module is used with the [Spectrometer](https://github.com/nqrduck/nqrduck-spectrometer) module. However you need to use an actual submodule of the spectrometer module like:
|
||||
The module is used with the [Spectrometer](https://git.private.coffee/nqrduck/nqrduck-spectrometer) module. However you need to use an actual submodule of the spectrometer module like:
|
||||
|
||||
- [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.
|
||||
- [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.
|
||||
|
||||
The pulse sequence and spectrometer settings can be adjusted using the 'Spectrometer' tab.
|
||||
|
||||
<img src="https://github.com/nqrduck/nqrduck-measurement/raw/0b28ae6b33230c6ca9eda85bd18de7cbcade27d1/docs/img/measurement_ui_labeled_v2.png" alt="drawing" width="800">
|
||||
<img src="https://git.private.coffee/nqrduck/nqrduck-measurement/raw/0b28ae6b33230c6ca9eda85bd18de7cbcade27d1/docs/img/measurement_ui_labeled_v2.png" alt="drawing" width="800">
|
||||
|
||||
- a.) The experiments settings for frequency and number of averages.
|
||||
- b.) The signal processing settings for the measurement.
|
||||
|
@ -56,4 +56,4 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
|
|||
|
||||
## Contributing
|
||||
|
||||
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.
|
||||
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.
|
||||
|
|
|
@ -63,8 +63,8 @@ convention = "google"
|
|||
|
||||
[project.urls]
|
||||
"Homepage" = "https://nqrduck.cool"
|
||||
"Bug Tracker" = "https://github.com/nqrduck/nqrduck-measurement/issues"
|
||||
"Source Code" = "https://github.com/nqrduck/nqrduck-measurement"
|
||||
"Bug Tracker" = "https://git.private.coffee/nqrduck/nqrduck-measurement/issues"
|
||||
"Source Code" = "https://git.private.coffee/nqrduck/nqrduck-measurement"
|
||||
|
||||
[tool.hatch.build.targets.wheel]
|
||||
packages = ["src/nqrduck_measurement"]
|
Loading…
Add table
Add a link
Reference in a new issue