Skip to content

Commit

Permalink
461: update docs and sonarQube
Browse files Browse the repository at this point in the history
  • Loading branch information
John-Sharples committed Sep 18, 2024
1 parent c3e0a45 commit 61d18ec
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 5 deletions.
22 changes: 22 additions & 0 deletions docs/Users_Guide/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,28 @@ file at the top level of the repository.

.. literalinclude:: ../../requirements.txt

Install METplotpy
-------------------

METplotpy can be installed into a conda environment. First navigate to the
base directory, then run the following commands.

.. code-block:: ini
$ conda create -n "metplotpy" python=3.10.4 pip
$ conda activate metplotpy
(metplotpy)$ pip install -e .
This will install METplotpy into the conda env, along with all the dependancies
listed above in **requirements.txt**.

If you already have an environment setup, or want to install METplotpy without
the dependancies, add the `--no-deps` argument to pip.

.. code-block:: ini
$ pip install -e . --no-deps
.. _METcalcpy_conda:

Install METcalcpy in the Conda Environment
Expand Down
4 changes: 2 additions & 2 deletions internal/scripts/sonarqube/sonar-project.properties
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ sonar.projectKey=METplotpy
sonar.projectName=METplotpy
sonar.projectVersion=SONAR_PROJECT_VERSION
sonar.branch.name=SONAR_BRANCH_NAME
sonar.sources=metplotpy,test
sonar.coverage.exclusions=test/**
sonar.sources=metplotpy
sonar.coverage.exclusions=test/**,contributed/**
sonar.python.coverage.reportPaths=coverage.xml
sonar.sourceEncoding=UTF-8

Expand Down
9 changes: 6 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,11 @@ build-backend = "setuptools.build_meta"

[project]
name = "metplotpy"
dynamic = ["version"]
dynamic = ["version", "dependencies"]
description = "plotting package for METplus"
authors = [
{name = "METplus", email = "[email protected]"},
]
dependencies = []
requires-python = ">=3.10.4"
readme = "README.md"
license = {text = "MIT"}
Expand All @@ -22,11 +21,15 @@ classifiers = [
[project.urls]
Homepage = "https://github.com/dtcenter/METplotpy"

[tool.setuptools.dynamic]
version = {attr = "metplotpy.__version__"}
dependencies = {file = ["requirements.txt"]}

[tool.setuptools]
packages = ["metplotpy"]

[tool.pytest.ini_options]
testpaths = ["test"]

[tool.coverage.run]
source = ["metplotpy"]
source = ["metplotpy/plots"]

0 comments on commit 61d18ec

Please sign in to comment.