GeomScale / dingo

A python library for metabolic networks sampling and analysis
GNU Lesser General Public License v3.0
42 stars 27 forks source link

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

Closed rkstu closed 3 months ago

rkstu commented 4 months ago

This is related to GeomScale/dingo issue https://github.com/GeomScale/dingo/issues/83

Instruction changes:

Installation Instructions in GitHub Codespaces added in readme file For a quick and hassle-free Dingo project trial, reference on how to setup python version 3.8.x in GitHub Codespaces added, from where user can follow rest of the installation steps.

Tutorial for local environment added A how to use dingo in local env file added in dingo/tutorials/dingo_walkthrough.ipynb. This is a smaller version of colab tutorial. User should be able to run all cells after complete installation.

Unit Tests All unit tests passed without issues(OK status), except for the test tests/rounding.py, which returned an error.

rounding_test_failed

output: tests/rounding.py

I followed these steps on my computer (Ubuntu 24.04) and GitHub Codespaces, and everything worked well for installing the Dingo project. If you have any suggestions or changes, please let me know.