Skip to content

Commit

Permalink
Version 0.4.1 doc
Browse files Browse the repository at this point in the history
- Write about the addition of the new two heuristics
- Update installation method to use Poetry
  • Loading branch information
fillipe-gsm committed Feb 2, 2024
1 parent 8d988fe commit 6c2ebe6
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 3 deletions.
9 changes: 9 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,14 @@ Release Notes and Changelog
Releases 0.4.X
--------------

Release 0.4.1
~~~~~~~~~~~~~
- Add Lin and Kernighan and Record to Record methods to the list of heuristic solvers. Thanks @luanleonardo for this contribution.

Keep in mind that these solvers are more recent and less tested, so if you experience a problem feel free to open an issue.

Python support: Python >= 3.9

Release 0.4.0
~~~~~~~~~~~~~

Expand Down Expand Up @@ -277,3 +285,4 @@ Contributors
============

- @FrickTobias
- @luanleonardo
7 changes: 4 additions & 3 deletions README_pypi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Installation
.. code:: bash
pip install python-tsp
poetry add python-tsp # if using Poetry in the project
Examples
Expand Down Expand Up @@ -41,7 +42,7 @@ To solve the same problem with a metaheuristic method:
from python_tsp.heuristics import solve_tsp_simulated_annealing
permutation, distance = solve_tsp_simulated_annealing(distance_matrix)
permutation, distance = solve_tsp_simulated_annealing(distance_matrix)
Keep in mind that, being a metaheuristic, the solution may vary from execution
to execution, and there is no guarantee of optimality. However, it may be a
Expand All @@ -61,7 +62,7 @@ this case the distance matrix is actually asymmetric, and the methods here are
applicable as well.

The previous examples assumed you already had a distance matrix. If that is not
the case, the ``distances`` module has prepared some functions to compute an
the case, the ``distances`` module has prepared some functions to compute an
Euclidean distance matrix or a
`Great Circle Distance <https://en.wikipedia.org/wiki/Great-circle_distance>`_.

Expand All @@ -81,5 +82,5 @@ of a point,
])
distance_matrix = great_circle_distance_matrix(sources)
See the `project's repository <https://github.com/fillipe-gsm/python-tsp>`_
See the `project's repository <https://github.com/fillipe-gsm/python-tsp>`_
for more examples and a list of available methods.

0 comments on commit 6c2ebe6

Please sign in to comment.