Change to forgejo.

This commit is contained in:
jupfi 2025-05-01 15:41:30 +02:00
parent 6481e674bf
commit 1c493ffd57
3 changed files with 15 additions and 18 deletions

View file

@ -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 }}

View file

@ -1,5 +1,5 @@
# NQRduck Module: Spectrometer Simulator
This module is a part of the NQRduck project. It is a submodule of the [spectrometer module](https://github.com/nqrduck/nqrduck-spectrometer) for the NQRduck project. It is designed to be used with the [NQRduck](https://github.com/nqrduck) project.
This module is a part of the NQRduck project. It is a submodule of the [spectrometer module](https://git.private.coffee/nqrduck/nqrduck-spectrometer) for the NQRduck project. It is designed to be used with the [NQRduck](https://git.private.coffee/nqrduck) project.
The module is used to simulate magnetic resonance experiments. It is based on the Bloch simulator by C. Graf [2].
@ -8,10 +8,10 @@ The module is used to simulate magnetic resonance experiments. It is based on th
### Requirements
The requirements for the module are handled by the pyproject.toml file. The user needs to install the NQRduck core.
The simulator module uses the [nqr-blochsimulator](https://github.com/nqrduck/nqr-blochsimulator) project for simulation of the bloch equation. This module is automatically installed when installing the simulator module.
The simulator module uses the [nqr-blochsimulator](https://git.private.coffee/nqrduck/nqr-blochsimulator) project for simulation of the bloch equation. This module is automatically installed when installing the simulator module.
### 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:
```bash
@ -29,7 +29,7 @@ pip install nqrduck-spectrometer-simulator
```
## Usage
The pulse sequence is graphically programmed using the [nqrduck-pulseprogrammer](htpps://github.com/nqrduck-pulseprogrammer) within the NQRduck program under the 'Spectrometer' tab.
The pulse sequence is graphically programmed using the [nqrduck-pulseprogrammer](htpps://git.private.coffee/nqrduck-pulseprogrammer) within the NQRduck program under the 'Spectrometer' tab.
### Notes

View file

@ -52,8 +52,8 @@ convention = "google"
[project.urls]
"Homepage" = "https://nqrduck.cool"
"Bug Tracker" = "https://github.com/nqrduck/nqrduck-spectrometer-simulator/issues"
"Source Code" = "https://github.com/nqrduck/nqrduck-spectrometer-simulator"
"Bug Tracker" = "https://git.private.coffee/nqrduck/nqrduck-spectrometer-simulator/issues"
"Source Code" = "https://git.private.coffee/nqrduck/nqrduck-spectrometer-simulator"
[tool.hatch.build.targets.wheel]
packages = ["src/nqrduck_spectrometer_simulator"]