diff --git a/README.md b/README.md index 2d94c38ccc81d70e8f1b0610b6afcf9ea2c9713b..1e7f64c13e2e02a35a5507f2f6491dd62c3b4bc2 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,41 @@ -# TSPNotTheSchool +# STSP using the Held and Karp algorithm -Julia module for the TSP using the Held and Kard relaxation \ No newline at end of file +Julia module for the Symmetric Travelling Salesman Problem using the Held and Kard relaxation. + +Our project is presented in the from of a Julia Jupyter notebook. + +# Requirements + +# Viewing the project + +## General presentation of notebooks + +Notebooks are a user-friendly way of mixing code with printed results and markdown/latex writing. + +A notebook is cut in blocks containing either code, printed results or markdown/latex. Each block can be run separately, and all the functions/variables declared in it are stored in the current session. + +It is important to note than blocks need preferably be executed from the top down, because the variables and function calls used in a block might depend on previous blocks. + + + +## Visualizing our notebook + +The simplest way is to go to the [nbviewer](https://nbviewer.jupyter.org/) website and type + +``` +https://signolle.iiens.net/files/heldAndKarp.ipynb +``` + +in the search bar. + + + +Alternatively, you can open the notebook in a notebook editor. For information about installing such an editor, you can go to either the [Jupyter installation page](https://jupyter.org/install) or the [Pluto installation page](https://plutojl.org/#lets-do-it). Note that in order to run the blocks in the notebook rather than just seeing them, you will need to [download and install Julia > 1.4.2](https://julialang.org/downloads/). + +## Converting to a classic Julia script + +If you just want to see/run the code without the printing and block structure, you might want to [install nbconvert](https://nbconvert.readthedocs.io/en/latest/install.html) and run in a shell terminal the following command : + +``` +jupyter nbconvert --to script heldAndKarp.ipynb +``` diff --git a/images/nb.png b/images/nb.png new file mode 100644 index 0000000000000000000000000000000000000000..8cb1304c6eca3a57bfcf6dc6b6f2d53f852e53d5 Binary files /dev/null and b/images/nb.png differ diff --git a/images/nbviewer.png b/images/nbviewer.png new file mode 100644 index 0000000000000000000000000000000000000000..23e772e70b30b8d340b5e2f0d817906a245f6712 Binary files /dev/null and b/images/nbviewer.png differ