Metadata-Version: 2.4
Name: lofar-lotus
Version: 0.0.15
Summary: Lots of things used somewhere
License-Expression: Apache-2.0
Project-URL: homepage, https://git.astron.nl/lofar2.0/lotus
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: pyzmq>=24
Requires-Dist: h5py!=3.15.*,>=3.1.0
Requires-Dist: prometheus-client
Dynamic: license-file

# LOFAR LOTUS

![Build status](git.astron.nl/lofar2.0/lotus/badges/main/pipeline.svg)
![Test coverage](git.astron.nl/lofar2.0/lotus/badges/main/coverage.svg)
<!-- ![Latest release](https://git.astron.nl/templates/python-package/badges/main/release.svg) -->

Common library containing various stuff for LOFAR2.

## Installation

Wheel distributions are available from the [gitlab package registry](https://git.astron.nl/lofar2.0/lotus/-/packages/),
install using after downloading:

```shell
python -m pip install *.whl
```

Alternatively install latest version on master using:

```shell
python -m pip install lofar-lotus@git+https://git.astron.nl/lofar2.0/lotus
```

Or install directly from the source at any branch or commit:

```shell
python -m pip install ./
```

##  Usage

For more thorough usage explanation please consult the documentation

## Development

### Development environment

To set up and activate the develop environment run ```source ./setup.sh``` from within the source directory.

If PyCharm is used, this only needs to be done once.
Afterward the Python virtual env can be setup within PyCharm.

### Contributing
To contribute, please create a feature branch and a "Draft" merge request.
Upon completion, the merge request should be marked as ready and a reviewer
should be assigned.

Verify your changes locally and be sure to add tests. Verifying local
changes is done through `tox`.

```python -m pip install tox```

With tox the same jobs as run on the CI/CD pipeline can be executed. These
include unit tests and linting.

```tox```

To automatically apply most suggested linting changes execute:

```tox -e format```

## License
This project is licensed under the Apache License Version 2.0
