Skip to content

Commit

Permalink
Removing SDK from the package
Browse files Browse the repository at this point in the history
  • Loading branch information
bvandekerkhof committed Feb 7, 2025
1 parent 25d6ab9 commit 490fcea
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 24 deletions.
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ SPDX-License-Identifier: Apache-2.0

<div align="center">

[![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)

Expand All @@ -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
Expand Down Expand Up @@ -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.
Expand Down
8 changes: 2 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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/"
Expand Down
8 changes: 0 additions & 8 deletions src/pyelq/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
)

0 comments on commit 490fcea

Please sign in to comment.