diff --git a/README.md b/README.md index dfbcc518341e4f10f642f385b1b60633f56b5ee0..6786f0ddb31e0616bf10161f94e80f09f8afeb1b 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ install the geo packages. For special instructions to install MLAir on the Jueli * Installation of **MLAir**: * Either clone MLAir from the [gitlab repository](https://gitlab.version.fz-juelich.de/toar/mlair.git) 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 inside your virtual environment using `import mlair`. diff --git a/development_guidelines.md b/development_guidelines.md new file mode 100644 index 0000000000000000000000000000000000000000..b847f06010b9d6d4b718373142e8088b4119c5df --- /dev/null +++ b/development_guidelines.md @@ -0,0 +1,16 @@ +# 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 diff --git a/dist/mlair-0.12.2-py3-none-any.whl b/dist/mlair-0.12.2-py3-none-any.whl new file mode 100644 index 0000000000000000000000000000000000000000..2f95aa992446e8eac69ac1c4512ea78181b6c202 Binary files /dev/null and b/dist/mlair-0.12.2-py3-none-any.whl differ diff --git a/docs/_source/get-started.rst b/docs/_source/get-started.rst index 7c909b778ca12dfd74497c90d60d62adf9801b29..7dda0eccb41281f6d15b4434b7e13ed2aa332d35 100644 --- a/docs/_source/get-started.rst +++ b/docs/_source/get-started.rst @@ -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>`_ preferably in a virtual environment * 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`.