diff --git a/.github/workflows/publish-docker.yml b/.github/workflows/publish-docker.yml index 8583c01..78326b6 100644 --- a/.github/workflows/publish-docker.yml +++ b/.github/workflows/publish-docker.yml @@ -27,10 +27,10 @@ jobs: uses: actions/checkout@v4 - name: Log in to Docker Hub - uses: docker/login-action@f4ef78c080cd8ba55a85445d5b36e214a81df20a + uses: docker/login-action@v3 with: username: ${{ secrets.DOCKER_USERNAME }} - password: ${{ secrets.DOCKER_PASSWORD }} + password: ${{ secrets.DOCKERHUB_TOKEN }} - name: Extract metadata (tags, labels) for Docker id: meta @@ -43,7 +43,7 @@ jobs: uses: docker/build-push-action@3b5e8027fcad23fda98b2e3ac259d8d67585f671 with: context: . - file: ./Dockerfile + file: ./tests/Dockerfile push: true tags: ${{ steps.meta.outputs.tags }} labels: ${{ steps.meta.outputs.labels }} diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml deleted file mode 100644 index cb05240..0000000 --- a/.gitlab-ci.yml +++ /dev/null @@ -1,96 +0,0 @@ -stages: - - docker - - tests - - quality - - docs - - deploy - -docker: - stage: docker - image: docker:19.03.12 - services: - - docker:19.03.12-dind - tags: - - lower-privacy - - docker - - ubuntu - - meta - script: - - export IMAGE_NAME=$CI_REGISTRY_IMAGE - - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY - - cd tests && docker build -t $IMAGE_NAME:$CI_COMMIT_REF_NAME . - - docker push $IMAGE_NAME - rules: - - if: $CI_COMMIT_TAG - when: never - - if: $DOCKER_BASE - when: always - - when: never - - if: $CI_PIPELINE_SOURCE == 'merge_request_event' - when: never - -test: - stage: tests - image: git.ccfe.ac.uk:4567/marte21/public/marte2_python:develop - script: - - pytest --cov=martepy --cov-report=term --cov-report=html:cov_html --cov-fail-under=90 - tags: - - lower-privacy - - docker - - ubuntu - - meta - artifacts: - paths: - - cov_html/ - expire_in: 30 days - when: always - -linting: - stage: quality - image: git.ccfe.ac.uk:4567/marte21/public/marte2_python:develop - script: - - pylint martepy - tags: - - lower-privacy - - docker - - ubuntu - - meta - when: always - -docs: - stage: docs - image: git.ccfe.ac.uk:4567/marte21/public/marte2_python:develop - script: - - cd docs - - make html - tags: - - lower-privacy - - docker - - ubuntu - - meta - artifacts: - paths: - - docs/build/html - expire_in: 1 week - rules: - - if: '$CI_COMMIT_BRANCH == "main"' - when: always - -pages: - stage: deploy - script: - - mkdir -p public/ - - rm -rf public/* - - cp -a docs/build/html/* public/ - tags: - - lower-privacy - - docker - - ubuntu - - meta - artifacts: - paths: - - public/ - expire_in: 1 year - rules: - - if: '$CI_COMMIT_BRANCH == "main"' - when: always diff --git a/README.md b/README.md index cf56d64..02a58e9 100644 --- a/README.md +++ b/README.md @@ -32,15 +32,15 @@ pip install martepy You can find example for how to use this repository here: -[Simple Example](https://marte21.gitpages.ccfe.ac.uk/public/marte2_python/getting_started.html) +[Simple Example](https://ukaea.github.io/MARTe2-python/getting_started.html) -[Water Tank Example](https://marte21.gitpages.ccfe.ac.uk/public/marte2_python/water_tank.html) +[Water Tank Example](https://ukaea.github.io/MARTe2-python/water_tank.html) ## Support For support on using this codebase you can refer to the documentation found here: -[User Documentation](https://marte21.gitpages.ccfe.ac.uk/public/marte2_python/) +[User Documentation](https://ukaea.github.io/MARTe2-python/) If you have found a bug or have a feature request then please submit an issue within this repository. diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index e2df50d..b5647a2 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -8,9 +8,7 @@ Getting Started First, clone and install this repository and it's dependencies:: - $ git clone https://git.ccfe.ac.uk/marte21/public/marte2_python.git - $ cd marte2_python - $ pip install ./ + $ pip install martepy .. note:: @@ -178,4 +176,4 @@ Next steps: - Review the `water tank example <./water_tank.html>`_. - It is encouraged to read up on the `simulation framework <./simulation.html>`_. -- Alot of operational functions and configurations were ignored in this example, the default set up is usually adequate for an application but you may want to review the other `examples available `_. \ No newline at end of file +- Alot of operational functions and configurations were ignored in this example, the default set up is usually adequate for an application but you may want to review the other `examples available `_. \ No newline at end of file diff --git a/docs/source/related.rst b/docs/source/related.rst index 56787cf..c65ac7e 100644 --- a/docs/source/related.rst +++ b/docs/source/related.rst @@ -16,7 +16,7 @@ See also - the `MARTe2 source`_, the `MARTe2 components source`_ and the `MARTe2 docs`_ - the `MARTe2 2019 users meeting`_ and the `training material repository`_ -.. _`the source`: https://git.ccfe.ac.uk/marte21/public/marte2_python +.. _`the source`: https://github.com/ukaea/MARTe2-python .. _`MARTe2 source`: https://vcis-gitlab.f4e.europa.eu/aneto/MARTe2 .. _`MARTe2 components source`: https://vcis-gitlab.f4e.europa.eu/aneto/MARTe2-components .. _`MARTe2 docs`: https://vcis.f4e.europa.eu/marte2-docs/master/html diff --git a/docs/source/support.rst b/docs/source/support.rst index ffd77c6..d56f897 100644 --- a/docs/source/support.rst +++ b/docs/source/support.rst @@ -31,5 +31,5 @@ For more general questions on the implementation, contact any of .. _`MARTe Discord server`: https://discord.gg/anSXWtnprW .. _`Edward Jones`: mailto:edward.jones1@ukaea.uk .. _`Hudson Baker`: mailto:hudson.baker@ukaea.uk -.. _`contributors list on GitLab`: https://git.ccfe.ac.uk/marte21/public/marte2_python/-/graphs/main +.. _`contributors list on GitLab`: https://github.com/ukaea/MARTe2-python/graphs/contributors .. _`Adam Stephen`: mailto:adam.stephen@ukaea.uk diff --git a/docs/source/water_tank.rst b/docs/source/water_tank.rst index 1d5428c..ec10fa0 100644 --- a/docs/source/water_tank.rst +++ b/docs/source/water_tank.rst @@ -234,4 +234,4 @@ So great! We have used python to generate a MARTe2 configuration and then execut Next steps: - It is encouraged to read up on the `simulation framework <./simulation.html>`_. -- Alot of operational functions and configurations were ignored in this example, the default set up is usually adequate for an application but you may want to review the other `examples available `_. \ No newline at end of file +- Alot of operational functions and configurations were ignored in this example, the default set up is usually adequate for an application but you may want to review the other `examples available `_. \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index 231c37b..aa4deda 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta" [project] name = "martepy" version = "1.0.0" -description = """Python modules that wrap MARTe2 classes and objects into python classes for automation and simplification purposes of developing MARTe2 applications. This also provides tools that are useful for working with MARTe2.""" +description = """This repository provides python classes which represent MARTe2 GAMs, DataSources and applications. Alongside this it provides useful frameworks for debugging and developing applications with MARTe2.""" readme = "README.md" authors = [ { name = "Edward Jones", email = "edward.jones1@ukaea.uk" }