| @@ -32,32 +32,38 @@ To learn how to use it, please refer to - [document](https://www.lamda.nju.edu.c | |||||
| ## Installation | ## Installation | ||||
| ### Install from PyPI | |||||
| The easiest way to install ABL-Package is using ``pip``: | The easiest way to install ABL-Package is using ``pip``: | ||||
| ```bash | ```bash | ||||
| # (TODO) | # (TODO) | ||||
| $ pip install abl | |||||
| pip install abl | |||||
| ``` | ``` | ||||
| For testing purposes, you can install it using: | For testing purposes, you can install it using: | ||||
| ```bash | ```bash | ||||
| $ pip install -i https://test.pypi.org/simple/ --extra-index-url https://mirrors.nju.edu.cn/pypi/web/simple/ abl | |||||
| pip install -i https://test.pypi.org/simple/ --extra-index-url https://mirrors.nju.edu.cn/pypi/web/simple/ abl | |||||
| ``` | ``` | ||||
| Alternatively, to install by source code, sequentially run following commands in your terminal/command line. | |||||
| ### Install from Source | |||||
| Alternatively, to install from source code, sequentially run following commands in your terminal/command line. | |||||
| ```bash | ```bash | ||||
| $ git clone https://github.com/AbductiveLearning/ABL-Package.git | |||||
| $ cd ABL-Package | |||||
| $ pip install -v -e . | |||||
| git clone https://github.com/AbductiveLearning/ABL-Package.git | |||||
| cd ABL-Package | |||||
| pip install -v -e . | |||||
| ``` | ``` | ||||
| (Optional) If the use of a [Prolog-based knowledge base](https://www.lamda.nju.edu.cn/abl_test/docs/build/html/Intro/Reasoning.html#prolog) is necessary, the installation of [Swi-Prolog](https://www.swi-prolog.org/) is also required: | |||||
| ### (Optional) Install Swi-Prolog | |||||
| If the use of a [Prolog-based knowledge base](https://www.lamda.nju.edu.cn/abl_test/docs/build/html/Intro/Reasoning.html#prolog) is necessary, please also install [Swi-Prolog](https://www.swi-prolog.org/): | |||||
| For Linux users: | For Linux users: | ||||
| ```bash | ```bash | ||||
| $ sudo apt-get install swi-prolog | |||||
| sudo apt-get install swi-prolog | |||||
| ``` | ``` | ||||
| For Windows and Mac users, please refer to the [Swi-Prolog Install Guide](https://github.com/yuce/pyswip/blob/master/INSTALL.md). | For Windows and Mac users, please refer to the [Swi-Prolog Install Guide](https://github.com/yuce/pyswip/blob/master/INSTALL.md). | ||||
| @@ -1,34 +1,43 @@ | |||||
| Installation | Installation | ||||
| ================== | ================== | ||||
| Install from PyPI | |||||
| ^^^^^^^^^^^^^^^^^ | |||||
| The easiest way to install ABL-Package is using ``pip``: | The easiest way to install ABL-Package is using ``pip``: | ||||
| .. code:: console | .. code:: console | ||||
| # (TODO) | # (TODO) | ||||
| $ pip install abl | |||||
| pip install abl | |||||
| For testing purposes, you can install it using: | For testing purposes, you can install it using: | ||||
| .. code:: console | .. code:: console | ||||
| $ pip install -i https://test.pypi.org/simple/ --extra-index-url https://mirrors.nju.edu.cn/pypi/web/simple/ abl | |||||
| pip install -i https://test.pypi.org/simple/ --extra-index-url https://mirrors.nju.edu.cn/pypi/web/simple/ abl | |||||
| Install from Source | |||||
| ^^^^^^^^^^^^^^^^^^^ | |||||
| Alternatively, to install by source code, | |||||
| Alternatively, to install from source code, | |||||
| sequentially run following commands in your terminal/command line. | sequentially run following commands in your terminal/command line. | ||||
| .. code:: console | .. code:: console | ||||
| $ git clone https://github.com/AbductiveLearning/ABL-Package.git | |||||
| $ cd ABL-Package | |||||
| $ pip install -v -e . | |||||
| git clone https://github.com/AbductiveLearning/ABL-Package.git | |||||
| cd ABL-Package | |||||
| pip install -v -e . | |||||
| (Optional) Install Swi-Prolog | |||||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |||||
| (Optional) If the use of a :ref:`Prolog-based knowledge base <prolog>` is necessary, the installation of `Swi-Prolog <https://www.swi-prolog.org/>`_ is also required: | |||||
| If the use of a :ref:`Prolog-based knowledge base <prolog>` is necessary, the installation of `Swi-Prolog <https://www.swi-prolog.org/>`_ is also required: | |||||
| For Linux users: | For Linux users: | ||||
| .. code:: console | .. code:: console | ||||
| $ sudo apt-get install swi-prolog | |||||
| sudo apt-get install swi-prolog | |||||
| For Windows and Mac users, please refer to the `Swi-Prolog Install Guide <https://github.com/yuce/pyswip/blob/master/INSTALL.md>`_. | For Windows and Mac users, please refer to the `Swi-Prolog Install Guide <https://github.com/yuce/pyswip/blob/master/INSTALL.md>`_. | ||||
| @@ -21,35 +21,44 @@ which leverage the power of both data and knowledge. | |||||
| Installation | Installation | ||||
| ------------ | ------------ | ||||
| Install from PyPI | |||||
| ^^^^^^^^^^^^^^^^^ | |||||
| The easiest way to install ABL-Package is using ``pip``: | The easiest way to install ABL-Package is using ``pip``: | ||||
| .. code:: console | .. code:: console | ||||
| # (TODO) | # (TODO) | ||||
| $ pip install abl | |||||
| pip install abl | |||||
| For testing purposes, you can install it using: | For testing purposes, you can install it using: | ||||
| .. code:: console | .. code:: console | ||||
| $ pip install -i https://test.pypi.org/simple/ --extra-index-url https://mirrors.nju.edu.cn/pypi/web/simple/ abl | |||||
| pip install -i https://test.pypi.org/simple/ --extra-index-url https://mirrors.nju.edu.cn/pypi/web/simple/ abl | |||||
| Install from Source | |||||
| ^^^^^^^^^^^^^^^^^^^ | |||||
| Alternatively, to install by source code, | |||||
| Alternatively, to install from source code, | |||||
| sequentially run following commands in your terminal/command line. | sequentially run following commands in your terminal/command line. | ||||
| .. code:: console | .. code:: console | ||||
| $ git clone https://github.com/AbductiveLearning/ABL-Package.git | |||||
| $ cd ABL-Package | |||||
| $ pip install -v -e . | |||||
| git clone https://github.com/AbductiveLearning/ABL-Package.git | |||||
| cd ABL-Package | |||||
| pip install -v -e . | |||||
| (Optional) Install Swi-Prolog | |||||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |||||
| (Optional) If the use of a :ref:`Prolog-based knowledge base <prolog>` is necessary, the installation of `Swi-Prolog <https://www.swi-prolog.org/>`_ is also required: | |||||
| If the use of a :ref:`Prolog-based knowledge base <prolog>` is necessary, the installation of `Swi-Prolog <https://www.swi-prolog.org/>`_ is also required: | |||||
| For Linux users: | For Linux users: | ||||
| .. code:: console | .. code:: console | ||||
| $ sudo apt-get install swi-prolog | |||||
| sudo apt-get install swi-prolog | |||||
| For Windows and Mac users, please refer to the `Swi-Prolog Install Guide <https://github.com/yuce/pyswip/blob/master/INSTALL.md>`_. | For Windows and Mac users, please refer to the `Swi-Prolog Install Guide <https://github.com/yuce/pyswip/blob/master/INSTALL.md>`_. | ||||