22 lines
779 B
Markdown
22 lines
779 B
Markdown
# OM
|
|
|
|
SLS-2 Online Model for beam dynamics
|
|
|
|
## Installation
|
|
|
|
```
|
|
pip install --index-url https://gitea.psi.ch/api/packages/sls/pypi/simple/ --extra-index-url https://pypi.org/simple sls2om
|
|
```
|
|
|
|
## Publish a new version of this package
|
|
|
|
0. Create changes in the code
|
|
1. Bump the version in `pyproject.toml` -- try to follow `https://semver.org/`
|
|
2. If you added new dependencies, add them to `pyproject.toml`
|
|
3. Add a git tag with the version you specified in `pyproject.toml`:
|
|
- `git tag v<version>`, for example: `git tag v0.3.0`
|
|
4. Push the git tag:
|
|
- `git push origin tag v<version>`, for example: `git push origin tag v0.3.0`
|
|
|
|
The actions in `.gitea/workflows/release.yml` will then be triggered and publish the new release to `https://gitea.psi.ch/sls/OM/packages`
|