From 5e86a555cf677311f5089c7e50b7d7b2b7912a67 Mon Sep 17 00:00:00 2001 From: LouisCarpentier42 Date: Wed, 9 Oct 2024 09:43:24 +0200 Subject: [PATCH] Setup GitHub --- .gitlab-ci.yml | 161 -------------------------- README.md | 4 +- docs/getting_started/examples.rst | 2 +- docs/getting_started/installation.rst | 14 +-- docs/index.rst | 2 +- pyproject.toml | 6 +- 6 files changed, 14 insertions(+), 175 deletions(-) delete mode 100644 .gitlab-ci.yml diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml deleted file mode 100644 index 41e9b70..0000000 --- a/.gitlab-ci.yml +++ /dev/null @@ -1,161 +0,0 @@ -# Official language image. Look for the different tagged releases at: -# https://hub.docker.com/r/library/python/tags/ - -# Change pip's cache directory to be inside the project directory since we can -# only cache local items. -variables: - PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip" - -# Pip's cache doesn't store the python packages -# https://pip.pypa.io/en/stable/topics/caching/ -# -# If you want to also cache the installed packages, you have to install -# them in a virtualenv and cache it as well. -cache: - paths: - - .cache/pip - - venv/ - -stages: - - unit-test - - documentation - -#################################################################################### -#################################### UNIT TESTS #################################### -#################################################################################### - -# A template to run the different unittests in the different subpackages in separate jobs -.unit-test: - stage: unit-test - variables: - PYTHON_VERSION: "" - DISABLE_NUMBA: 1 - rules: - - if: $CI_PIPELINE_SOURCE == 'merge_request_event' - - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH - image: python:$PYTHON_VERSION - services: - - maven:3.3.9-jdk-8 - before_script: - # Install java - - apt update - - wget https://download.java.net/java/GA/jdk21.0.2/f2283984656d49d69e91c558476027ac/13/GPL/openjdk-21.0.2_linux-x64_bin.tar.gz - - tar xvf openjdk-21.0.2_linux-x64_bin.tar.gz - - mv jdk-21.0.2/ /usr/local/jdk-21 - - tee -a /etc/profile.d/jdk21.sh<`_! +The examples described below are also available in the `examples notebook `_! .. _example-univariate-time-series: diff --git a/docs/getting_started/installation.rst b/docs/getting_started/installation.rst index 678a03b..70dba89 100644 --- a/docs/getting_started/installation.rst +++ b/docs/getting_started/installation.rst @@ -18,30 +18,30 @@ simply running the following command: pip install patsemb -From GitLab +From GitHub ----------- -You can also install ``PaTSEmb`` directly from `GitLab `_. +You can also install ``PaTSEmb`` directly from `GitHub `_. To install version ``X.Y.Z``, you can use the following command: .. code-block:: bash - pip install git+https://gitlab.kuleuven.be/m-group-campus-brugge/dtai_public/patsemb.git@X.Y.Z + pip install git+https://github.com/ML-KULeuven/PaTSEmb.git@X.Y.Z -The `release page `_ contains more +The `release page `_ contains more information regarding the different versions. It is also possible to install the latest, *unreleased* version using the following command: .. code-block:: bash - pip install git+https://gitlab.kuleuven.be/m-group-campus-brugge/dtai_public/patsemb.git + pip install git+https://github.com/ML-KULeuven/PaTSEmb.git From source ----------- It is also possible to install ``PaTSEmb`` directly from the source code. First, download -the source from `GitLab `_. It is also -possible to download the source code for a specific release on `the release page `_. +the source from `GitHub `_. It is also +possible to download the source code for a specific release on `the release page `_. Unzip the files, and navigate to the root directory of the repository in the terminal. Finally, ``PaTSEmb`` can be installed through the following command: diff --git a/docs/index.rst b/docs/index.rst index 9c52c4b..b42a1e5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,7 +6,7 @@ Welcome to ``PaTSEmb``, a fast and extendable Python package for creating a patt of the time series. This is an embedding of the time series which contains information about the typical shapes are occurring at which locations in the time series. -The source is available on `GitLab `_. +The source is available on `GitHub `_. .. toctree:: :maxdepth: 1 diff --git a/pyproject.toml b/pyproject.toml index 10be7dd..75a6b53 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -27,9 +27,9 @@ file = "LICENSE" [project.urls] homepage = "https://pypi.org/project/patsemb/" -repository = "https://gitlab.kuleuven.be/m-group-campus-brugge/dtai_public/patsemb" -changelog = "https://gitlab.kuleuven.be/m-group-campus-brugge/dtai_public/patsemb/-/blob/main/CHANGELOG.md" -documentation = "https://patsemb-u0143709-3a07c9d27a51b62b1b2bad2f623ad154a9a19db833f1f7.pages.gitlab.kuleuven.be/" +repository = "https://github.com/ML-KULeuven/PaTSEmb" +changelog = "https://github.com/ML-KULeuven/PaTSEmb/blob/main/CHANGELOG.md" +documentation = "https://PaTSEmb.readthedocs.io/" [build-system] requires = ["setuptools", "wheel", "build"]