hotopy 0.21__tar.gz

hotopy-0.21/.gitignore

@@ -0,0 +1,147 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+#build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Visual Studio Code settings
+.vscode/
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# MacOS related
+.DS_Store
+
+# PyCharm files
+.idea

hotopy-0.21/.gitlab-ci.yml

@@ -0,0 +1,137 @@
+image: python:3.12
+
+stages:
+  - lint
+  - build
+  - deploy
+
+
+ruff-check:
+  stage: lint
+  script:
+    - pip install --no-cache-dir ruff
+    - ruff check -o ruff-check.log src/
+  artifacts:
+    when: on_failure
+    paths:
+      - ruff-check.log
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+
+
+ruff-format:
+  stage: lint
+  script:
+    - pip install --no-cache-dir ruff
+    - ruff format --check src/
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+
+
+sphinx:
+  stage: lint
+  script:
+    - apt-get update -y
+    - apt-get install -y pandoc
+    - pip install --no-cache-dir sphinx pydata-sphinx-theme sphinxcontrib-bibtex
+    - pip install --no-cache-dir numpy scipy ipykernel nbsphinx tqdm
+    - cd doc
+    - tmp=$(mktemp -d)
+    - sphinx-build -b html source $tmp
+    - code=$?
+    - rm -rf $tmp
+    - exit $code
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+
+
+build_conda:
+  stage: build
+  image: mambaorg/micromamba
+  #  image: condaforge/miniforge3
+  script:
+    - micromamba install -c conda-forge rattler-build -y --quiet
+    - rattler-build build --experimental --recipe conda/recipe.yaml --output-dir /tmp/rattler/
+    - mkdir conda-dist
+    - cp -r /tmp/rattler/noarch conda-dist/
+  artifacts:
+    paths:
+      - conda-dist/noarch/*
+  rules:
+    # run only if tag in format 'vXXX' is created
+    - if: $CI_COMMIT_TAG =~ /^v\S+/
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+
+
+build_whl:
+  stage: build
+  script:
+    - pip install --no-cache-dir build
+    - python -m build
+  artifacts:
+    paths:
+      - dist
+  rules:
+    - if: $CI_COMMIT_TAG =~ /^v\S+/
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+
+
+pages:
+  stage: deploy
+  script:
+    - apt-get update -y
+    - apt-get install -y pandoc
+    - pip install --no-cache-dir sphinx pydata-sphinx-theme sphinxcontrib-bibtex 
+    - pip install --no-cache-dir numpy scipy ipykernel nbsphinx tqdm
+    - cd doc
+    - sphinx-build -b html source build
+    - mv build ../public
+    - echo 'Done'
+  artifacts:
+    paths:
+      - public
+  rules:
+    # run only if tag in format 'vXXX' is created
+    - if: $CI_COMMIT_TAG =~ /^v\S+/
+
+
+upload_conda:
+  stage: deploy
+  dependencies:
+    - build_conda
+  script:
+    - apt-get update -q && apt-get install -q -y --no-install-recommends curl
+    - PKG_VERSION=${CI_COMMIT_TAG:1} # strip first character
+    - 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file conda-dist/noarch/hotopy-*.conda "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/generic/hotopy/${PKG_VERSION}/"'
+  rules:
+    # run only if tag in format 'vXXX' is created
+    - if: $CI_COMMIT_TAG =~ /^v\S+/
+
+
+upload_whl:
+  stage: deploy
+  dependencies:
+    - build_whl
+  script:
+    - pip install --no-cache-dir twine
+    - TWINE_PASSWORD=${CI_JOB_TOKEN} TWINE_USERNAME=gitlab-ci-token python -m twine upload --repository-url ${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/pypi dist/*
+  rules:
+    # run only if tag in format 'vXXX' is created
+    - if: $CI_COMMIT_TAG =~ /^v\S+/
+
+    #
+    #condabuild:
+    #  rules:
+    #    # run only if tag in format 'vXXX' is created
+    #    - if: $CI_COMMIT_TAG =~ /^v\S+/
+    #  stage: release
+    #  image: condaforge/miniforge3 
+    #  script:
+    #    - apt-get update -q && apt-get install -q -y --no-install-recommends curl
+    #    - conda install conda-build -y --quiet
+    #    - mkdir /opt/target
+    #    - conda-build --output-folder /opt/target .
+    #    - VERS=$(sed -rn 's/version\s?=\s?"(.+)"/\1/p' pyproject.toml)
+    #    - echo $VERS
+    #    - 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file /opt/target/noarch/hotopy-*.tar.bz2 "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/generic/conda/${VERS}/hotopy-${VERS}-${CI_COMMIT_SHORT_SHA}.tar.bz2"'
+

hotopy-0.21/.pre-commit-config.yaml

@@ -0,0 +1,11 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.10.0
+    hooks:
+      # Run the linter.
+      - id: ruff
+        files: ^src
+      # Run the formatter.
+      - id: ruff-format
+        files: ^src

hotopy-0.21/CONTRIBUTE.md

@@ -0,0 +1,44 @@
+## How to contribute
+
+Generally checkout the [NumPy developer docs](https://numpy.org/doc/stable/dev/howto-docs.html) and setup your git first.
+
+Clone the repository and setup pre-commit hooks
+```commandline
+git clone git@gitlab.gwdg.de:irp/hotopy.git
+cd hotopy
+```
+
+(Optional) Create a venv and launch it to your current shell
+```commandline
+python3 -m venv venv --prompt HoToPy
+source venv/bin/activate
+```
+
+Install `hotopy` module in editable mode (note: you may add the `--user` flag if you are not using venv's)
+```commandline
+pip install -e '.[dev,docs,tomo]'
+pre-commit install
+```
+
+Make a new branch for the new feature / fix you want to develop.
+```commandline
+git checkout -b <usefulandshortname>
+```
+
+Write the code. Make sure by running pre-commit it does not raise errors or warnings. You can check this anytime
+by running 
+```commandline
+pre-commit
+```
+
+Push your code to the corresponding branch in the remote repository.
+```commandline
+git push -u origin HEAD
+```
+
+At this point other people can see your code, but it is not part of the master branch, so you can get feedback and help without having to worry about breaking anything.
+
+When you are happy and think, your adjustments should be included in the master
+branch, create a merge request on the Gitlab website. Someone else will then check your code and merge it into the master branch if appropriate.
+
+Only when you know what you are doing and are certain not to break anything, small changes can also be pushed directly to the master branch.