diff --git a/README.md b/README.md old mode 100644 new mode 100755 index a6868a6963f2a3932e17d9973bb649c533ab8ae7..61392a92a0caaeecf2dcf4fc736d77189b73e07c --- a/README.md +++ b/README.md @@ -9,15 +9,16 @@ Finding a real estate in a new city is still a challenge. We often arrive in a c ## Installation instructions ### Requirements + - Python, version >=3 - [MongoDB](https://www.mongodb.com/), version >=4 for importing the database about neighbourhoods. ### Installation -For installing Predihood, type in a terminal: +For installing Predihood, go in the `predihood/` directory and run in a terminal: ``` -python3 -m pip install -e predihood/ --process-dependency-links +python3 -m pip install -e . -r requirements.txt ``` This command install dependencies, including [mongiris](https://gitlab.liris.cnrs.fr/fduchate/mongiris), a lightweight API which enables the querying of the MongoDB database containing information about French neighbourhoods. @@ -32,13 +33,13 @@ where `/path/to/` is the path to the dump file of the IRIS collection (provided ### Run Predihood -For running *Predihood*, type in a terminal: +For running *Predihood*, go in the `predihood/predihood/` directory and run in a terminal: ``` python3 main.py ``` -After some information, the terminal displays the URL for testing *Predihood* : `http://localhost:8080/`. +After some logging information, the terminal displays the URL for testing *Predihood* : `http://localhost:8081/`. ## Example usage @@ -50,9 +51,9 @@ For the cartographic interface, an example would be: For the algorithmic interface, an example would be: -1. Choose an algorithm -2. Tune it as desired -3. Click on "Train, test and evaluate" button. When computing accuracies is done, a table shows results for each environment variable and each list of indicators. +1. Select an algorithm in the list. +2. Configure your algorithm as desired by tuning available options. +3. Click on "Train, test and evaluate" button. After execution, a table summarizes results for each environment variable and each list of indicators. ## Tests diff --git a/requirements.txt b/requirements.txt old mode 100644 new mode 100755 index fa14102c4876d470bfabf1f8af2d966fbaa3485b..5741dc2726a8ca42aff4b1f82f0155cbfb494171 --- a/requirements.txt +++ b/requirements.txt @@ -2,12 +2,11 @@ setuptools~=41.2.0 numpy~=1.18.3 pandas~=1.0.3 area~=1.1.1 -predihood~=0.13 -sklearn~=0.0 -scikit-learn~=0.22.2.post1 +scikit-learn~=0.22 matplotlib~=3.2.1 seaborn~=0.10.1 Flask~=1.1.2 -mongiris~=0.40 requests~=2.23.0 -StringDist~=1.0.9 \ No newline at end of file +StringDist~=1.0.9 +https://gitlab.liris.cnrs.fr/fduchate/mongiris/-/archive/master/mongiris-master.zip + diff --git a/setup.cfg b/setup.cfg old mode 100644 new mode 100755 index 1c3bdc4cd16201f869f042f9a12644a0d83b9abc..6e2f1a9ec7e9812356bee3c5b87ff9b96fea7f5e --- a/setup.cfg +++ b/setup.cfg @@ -6,23 +6,13 @@ author = Fabien Duchateau author_email = fabien.duchateau@univ-lyon1.fr url = https://gitlab.liris.cnrs.fr/fduchate/predihood.git download_url = https://gitlab.liris.cnrs.fr/fduchate/predihood.git -keywords = visualization search INSEE IRIS +keywords = visualization search neighbourhood INSEE IRIS license_file = LICENSE [options] packages = find: include_package_data = True zip_safe = False -install_requires = - flask >= 1.0.2 - mongiris >= 0.3 -dependency_links = - git+https://fduchate@gitlab.liris.cnrs.fr/fduchate/mongiris.git#egg=mongiris-0.3 - -#[options.packages.find] -#exclude = -# tests.*, -# data/HiL/* [options.package_data] # package_data is ignored when a MANIFEST.in is provided diff --git a/setup.py b/setup.py index d3d2f8a6066f83627122f8f839f012e8b01db05a..8cc17a65f197b321cc623b3a005cc10bbc1f5be2 100755 --- a/setup.py +++ b/setup.py @@ -3,8 +3,7 @@ from setuptools import setup import shutil # python3 -m setup bdist_wheel sdist -# python3 -m pip install -e ../predihood/ -# installation: python -m pip install -e ../predihood/ --process-dependency-links +# python3 -m pip install -e . -r requirements.txt def delete_dir(directories): # delete directories (ignore errors such as read-only files) for directory in directories: @@ -16,5 +15,5 @@ delete_dir(["./predihood.egg-info/", "./build/", "./dist/"]) readme = open("README.md").read() -setup(long_description=readme, install_requires=["scikit-learn", "eli5", "matplotlib", "numpy", "pandas", "requests"]) +setup(long_description=readme, install_requires=["scikit-learn", "eli5", "matplotlib", "numpy", "pandas", "requests", "flask"])