Attention une mise à jour du service Gitlab va être effectuée le mardi 14 décembre entre 13h30 et 14h00. Cette mise à jour va générer une interruption du service dont nous ne maîtrisons pas complètement la durée mais qui ne devrait pas excéder quelques minutes.

Commit f1007b8b authored by MOMMESSIN Clement's avatar MOMMESSIN Clement
Browse files

[docs] Update README and CHANGELOG

parent 9b6286e9
.. _changelog:
Changelog
=========
All notable changes to this project will be documented in this file.
The format is based on `Keep a Changelog`_.
........................................................................................................................
Unreleased
----------
- `Commits since v3.0.0 <https://gitlab.inria.fr/batsim/pybatsim/compare/v3.0.0...master>`_
- ``nix-env -f https://github.com/oar-team/kapack/archive/master.tar.gz -iA pybatsim_dev``
........................................................................................................................
v3.0.0
------
- Release date: 2019-01-16
- `Commits since v2.1.1 <https://gitlab.inria.fr/batsim/pybatsim/compare/2.1.1...v3.0.0>`_
- ``nix-env -f https://github.com/oar-team/kapack/archive/master.tar.gz -iA pybatsim-3.0.0``
- Recommended Batsim version: `v3.0.0 <https://gitlab.inria.fr/batsim/batsim/tags/v3.0.0>`_
This version is synchronized with Batsim v3.0.0.
See `Batsim changelog <https://batsim.readthedocs.io/en/latest/changelog.html#v3-0-0>`_ for more details.
........................................................................................................................
v2.1.1
------
- Release date: 2018-08-31
- `Commits since v2.0.0 <https://gitlab.inria.fr/batsim/pybatsim/compare/2.0...2.1.1>`_
- ``nix-env -f https://github.com/oar-team/kapack/archive/master.tar.gz -iA pybatsim-2.1.1``
- Recommended Batsim version: `v2.0.0 <https://gitlab.inria.fr/batsim/batsim/tags/v2.0.0>`_
........................................................................................................................
v2.0.0
------
- Release date: 2017-10-03
- ``nix-env -f https://github.com/oar-team/kapack/archive/master.tar.gz -iA pybatsim-2.0``
- Recommended Batsim version: `v2.0.0 <https://gitlab.inria.fr/batsim/batsim/tags/v2.0.0>`_
.. _Keep a Changelog: http://keepachangelog.com/en/1.0.0/
\ No newline at end of file
......@@ -28,6 +28,17 @@ The following commands are provided:
To manipulate the `out_jobs.csv` file based on data only available in the
scheduler but not in Batsim.
Batsim Version Compatibilities
------------------------------
As there are different release paces between Batsim and Pybatsim versions, here is a list of compatibilities between the two projects:
- `Batsim master branch`_ with `Pybatsim master branch`_ (development branches, may be unstable)
- `Batsim v3_0_0`_ with `Pybatsim v3_0_0`_ (latest major release, stable)
- `Batsim v2_0_0`_ with `Pybatsim batsim_2_0_compatible`_
Moreover, all notable changes are listed in the :ref:`changelog`.
Examples
--------
......@@ -128,3 +139,11 @@ To run the test experiments it is preferable to first enter in a nix shell speci
Then you can run tests with the setup target::
./setup.py test --batsim-bin=path/to/batsim/binary
.. _Batsim master branch: https://gitlab.inria.fr/batsim/batsim/tree/master
.. _Pybatsim master branch: https://gitlab.inria.fr/batsim/pybatsim/tree/master
.. _Batsim v3_0_0: https://gitlab.inria.fr/batsim/batsim/tags/v3.0.0
.. _Pybatsim v3_0_0: https://gitlab.inria.fr/batsim/pybatsim/tags/v3.0.0
.. _Batsim v2_0_0: https://gitlab.inria.fr/batsim/batsim/tags/v2.0.0
.. _Pybatsim batsim_2_0_compatible: https://gitlab.inria.fr/batsim/pybatsim/tags/batsim_2.0_compatible
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment