Update README installation instructions to be more user friendly

rkstu commented 7 months ago

I encountered difficulties setting up the Dingo project completely for the first time and discussed the issues on Gitter. After repeatedly configuring the entire project over the past few weeks, particularly while addressing issue #83, I am convinced that making minor modifications to the README file can greatly streamline the setup process, ultimately saving considerable time and effort for new users

Challenges Faced:

Version incompatibility due to Python and project-dependent libraries.
Unclear instructions on the Poetry version for setup.

Proposed Change in instructions:

Make sure the Python version is 3.8 workflows

Install a specific version of poetry workflows

curl -sSL https://install.python-poetry.org | python3 - --version 1.3.2

Install the dependencies for the PySPQR library using

sudo apt-get update -y
sudo apt-get install -y libsuitesparse-dev

Proposal for trial For a quick and hassle-free Dingo project trial, consider using GitHub Codespaces. It provides an instant cloud-based development environment with limited free usage every month. Regardless of your operating system, you can set up and run experiments in under 10 minutes(depends on internet speed), thanks to its streamlined installation process. Additionally, consider utilizing another tab to include screenshots with installation steps and examples, which are mostly done.

vfisikop commented 7 months ago

Thanks, please feel free to open a PR with those changes.

vfisikop commented 7 months ago

Please also consult the information in this issue https://github.com/GeomScale/dingo/issues/77 regarding incompatibility of versions.

vikasgrewal16 commented 6 months ago

Is this issue closed or still open? @rkstu @vfisikop

vfisikop commented 6 months ago

It is open but there is a PR that is in progress https://github.com/GeomScale/dingo/pull/91 In general you are free to open your PR for the same issue but I do not recommend it for such a simple issue (it is only a documentation enhancement).

vfisikop commented 6 months ago

Closed by https://github.com/GeomScale/dingo/pull/91

GeomScale / dingo

Update README installation instructions to be more user friendly #89