From 490fcea0e17409e9fbd38ee8d3760b11dee23a0a Mon Sep 17 00:00:00 2001 From: bvandekerkhof Date: Fri, 7 Feb 2025 11:24:48 +0100 Subject: [PATCH] Removing SDK from the package --- README.md | 12 ++++-------- docs/index.md | 8 ++------ pyproject.toml | 4 ++-- src/pyelq/__init__.py | 8 -------- 4 files changed, 8 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 8e31b88..992db1e 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,8 @@ SPDX-License-Identifier: Apache-2.0
-[![PyPI version](https://img.shields.io/pypi/v/pyelq-sdk.svg?logo=pypi&logoColor=FFE873)](https://pypi.org/project/pyelq-sdk/) -[![Supported Python versions](https://img.shields.io/pypi/pyversions/pyelq-sdk.svg?logo=python&logoColor=FFE873)](https://pypi.org/project/pyelq-sdk/) +[![PyPI version](https://img.shields.io/pypi/v/pyelq.svg?logo=pypi&logoColor=FFE873)](https://pypi.org/project/pyelq/) +[![Supported Python versions](https://img.shields.io/pypi/pyversions/pyelq.svg?logo=python&logoColor=FFE873)](https://pypi.org/project/pyelq/) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Code Style Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) @@ -25,10 +25,6 @@ SPDX-License-Identifier: Apache-2.0 This repository contains the Python Emission Localization and Quantification software we call pyELQ. It is code used for gas dispersion modelling, in particular methane emissions detection, localization and quantification. -# IMPORTANT NOTICE -We will move pyELQ from the pyELQ-sdk project on PyPi to the pyELQ project soon. Please consider installing through the -new project on [PyPi](https://pypi.org/project/pyelq/). - *** # Background The **py**thon **E**mission **L**ocalization and **Q**uantification (pyELQ) code aims to maximize effective use of @@ -77,8 +73,8 @@ Therefore, careful interpretation of the data is always required. *** # Installing pyELQ as a package Suppose you want to use this pyELQ package in a different project. -You can install it from [PyPi](https://pypi.org/project/pyelq-sdk/) through pip -`pip install pyelq-sdk`. +You can install it from [PyPi](https://pypi.org/project/pyelq/) through pip +`pip install pyelq`. Or you could clone the repository and install it from the source code. After activating the environment you want to install pyELQ in, open a terminal, move to the main pyELQ folder where pyproject.toml is located and run `pip install .`, optionally you can pass the `-e` flag is for editable mode. diff --git a/docs/index.md b/docs/index.md index 1f69342..71ff562 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,10 +8,6 @@ SPDX-License-Identifier: Apache-2.0 This repository contains the Python Emission Localization and Quantification software we call pyELQ. It is code used for gas dispersion modelling, in particular methane emissions detection, localization and quantification. -# IMPORTANT NOTICE -We will move pyELQ from the pyELQ-sdk project on PyPi to the pyELQ project soon. Please consider installing through the -new project on [PyPi](https://pypi.org/project/pyelq/). - *** # Background The **py**thon **E**mission **L**ocalization and **Q**uantification (pyELQ) code aims to maximize effective use of @@ -59,8 +55,8 @@ Therefore, careful interpretation of the data is always required. *** # Installing pyELQ as a package Suppose you want to use this pyELQ package in a different project. -You can install it from [PyPi](https://pypi.org/project/pyelq-sdk/) through pip -`pip install pyelq-sdk`. +You can install it from [PyPi](https://pypi.org/project/pyelq/) through pip +`pip install pyelq`. Or you could clone the repository and install it from the source code. After activating the environment you want to install pyELQ in, open a terminal, move to the main pyELQ folder where pyproject.toml is located and run `pip install .`, optionally you can pass the `-e` flag is for editable mode. diff --git a/pyproject.toml b/pyproject.toml index a285641..977c29d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,8 +7,8 @@ requires = ["poetry-core>=1.0.0"] build-backend = "poetry.core.masonry.api" [tool.poetry] -name = "pyelq-sdk" -version = "1.0.14" +name = "pyelq" +version = "1.1.0" description = "Package for detection, localization and quantification code." authors = ["Bas van de Kerkhof", "Matthew Jones", "David Randell"] homepage = "https://sede-open.github.io/pyELQ/" diff --git a/src/pyelq/__init__.py b/src/pyelq/__init__.py index 82f05c0..8c80adf 100644 --- a/src/pyelq/__init__.py +++ b/src/pyelq/__init__.py @@ -17,11 +17,3 @@ "preprocessing", "source_map", ] - -from warnings import warn - -warn( - "The pyELQ package will move from the pyelq-sdk project to the pyelq project on PyPi in future version. Please condider installing this package through https://pypi.org/project/pyelq/.", - FutureWarning, - stacklevel=2, -)