Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README installation instructions to be more user friendly #89

Closed
rkstu opened this issue Feb 29, 2024 · 5 comments
Closed

Update README installation instructions to be more user friendly #89

rkstu opened this issue Feb 29, 2024 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@rkstu
Copy link
Contributor

rkstu commented Feb 29, 2024

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.

dingo_poetry

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 vfisikop added the documentation Improvements or additions to documentation label Mar 1, 2024
@vfisikop vfisikop changed the title Enhancement: Improve README for Improved Install Instructions and Interpretability Update README installation instructions to be more user friendly Mar 1, 2024
@vfisikop
Copy link
Contributor

vfisikop commented Mar 1, 2024

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

@vfisikop
Copy link
Contributor

vfisikop commented Mar 1, 2024

Please also consult the information in this issue #77 regarding incompatibility of versions.

@vikasgrewal16
Copy link

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

@vfisikop
Copy link
Contributor

vfisikop commented Mar 19, 2024

It is open but there is a PR that is in progress #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 pushed a commit that referenced this issue Mar 28, 2024
…91)

* Update README installation instructions to be more user friendly #89

* Update README.md

* Update README.md

* Update dingo_walkthrough.ipynb

* Update README.md

* Delete tutorials/dingo_walkthrough.ipynb
@vfisikop
Copy link
Contributor

Closed by #91

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants