Skip to content
Snippets Groups Projects
Commit aff27853 authored by leufen1's avatar leufen1
Browse files

update on version number, changelog, dist, readme, and docs

parent b0b449f1
No related branches found
No related tags found
3 merge requests!160update develop,!158Resolve "new release v0.12.2",!139Draft: Resolve "KZ filter"
...@@ -26,7 +26,7 @@ install the geo packages. For special instructions to install MLAir on the Jueli ...@@ -26,7 +26,7 @@ install the geo packages. For special instructions to install MLAir on the Jueli
* Installation of **MLAir**: * Installation of **MLAir**:
* Either clone MLAir from the [gitlab repository](https://gitlab.version.fz-juelich.de/toar/mlair.git) * Either clone MLAir from the [gitlab repository](https://gitlab.version.fz-juelich.de/toar/mlair.git)
and use it without installation (beside the requirements) and use it without installation (beside the requirements)
* or download the distribution file ([current version](https://gitlab.version.fz-juelich.de/toar/mlair/-/blob/master/dist/mlair-0.12.1-py3-none-any.whl)) * or download the distribution file ([current version](https://gitlab.version.fz-juelich.de/toar/mlair/-/blob/master/dist/mlair-0.12.2-py3-none-any.whl))
and install it via `pip install <dist_file>.whl`. In this case, you can simply import MLAir in any python script and install it via `pip install <dist_file>.whl`. In this case, you can simply import MLAir in any python script
inside your virtual environment using `import mlair`. inside your virtual environment using `import mlair`.
......
# GUIDELINES
## release of new version
* Create Release Issue
* Create merge request: branch `release_vX.Y.Z` into `master`
* Merge `develop` into `release_vX.Y.Z`
* Checkout `release_vX.Y.Z`
* Adjust `changelog.md`
* Update version number in `mlair/__ init__.py`
* Create new dist file: `python3 setup.py sdist bdist_wheel`
* Update file link in `README.md`
* Update file link in `docs/_source/get-started.rst`
* Commit + push
* Merge `release_vX.Y.Z` into `master`
* Create new tag
File added
...@@ -31,7 +31,8 @@ Installation of MLAir ...@@ -31,7 +31,8 @@ Installation of MLAir
* Install all requirements from `requirements.txt <https://gitlab.version.fz-juelich.de/toar/machinelearningtools/-/blob/master/requirements.txt>`_ * Install all requirements from `requirements.txt <https://gitlab.version.fz-juelich.de/toar/machinelearningtools/-/blob/master/requirements.txt>`_
preferably in a virtual environment preferably in a virtual environment
* Either clone MLAir from the `gitlab repository <https://gitlab.version.fz-juelich.de/toar/machinelearningtools.git>`_ * Either clone MLAir from the `gitlab repository <https://gitlab.version.fz-juelich.de/toar/machinelearningtools.git>`_
* or download the distribution file (?? .whl) and install it via :py:`pip install <??>`. In this case, you can simply * or download the distribution file (`current version <https://gitlab.version.fz-juelich.de/toar/mlair/-/blob/master/dist/mlair-0.12.2-py3-none-any.whl>`_)
and install it via :py:`pip install <dist_file>.whl`. In this case, you can simply
import MLAir in any python script inside your virtual environment using :py:`import mlair`. import MLAir in any python script inside your virtual environment using :py:`import mlair`.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment