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

Overview issue: documentation structure #137

Closed
26 tasks done
exaexa opened this issue Apr 29, 2021 · 2 comments · Fixed by #366
Closed
26 tasks done

Overview issue: documentation structure #137

exaexa opened this issue Apr 29, 2021 · 2 comments · Fixed by #366
Assignees

Comments

@exaexa
Copy link
Collaborator

exaexa commented Apr 29, 2021

The docs are more like a collection of ideas now, we should give it a clear tutorial structure.

My idea for the structure is as follows:

  • Introduction, what does COBREXA solve and what it does not solve
  • Totally primitive example ((down)load 1 model and do 1 FBA)
  • Section with tutorials
    • Model loading and conversion
    • Running FBA, FVA and sampling on small models
    • Running FVA on HPCs
    • Modifying and saving the models (Serialize, "export" through conversion to JSON/MAT and saving.)
  • Section with advanced tutorials
    • Using modifications to scan for many model properties at once (this still needs to be implemented, but it's hopefully 50LOC :D )
    • Using a custom model structure
    • Writing own reconstructions and modifications and running them on HPC
    • Using the extra information in StdModel to screen through many model variants, e.g. knockouts or something (I guess some of the original tutorials may sink in here)
  • Examples (aka backing notebooks)
    • Loading and saving
    • Simple FBA and FVA
    • Sampling and seeing the results
    • Parallel FVA
    • Knockouts
    • Custom models
  • Function documentation (REFERENCE, this should correspond to the structure in src/ as much as possible. I'd still separate it into some roughly consistent functions ordered by kinda bottom-up structure)
    • Types
    • IO
    • Analysis functions
    • Sampling
    • Modifications and reconstruction functions
    • Utils+misc

Feel free to edit/suggest.

@exaexa
Copy link
Collaborator Author

exaexa commented Apr 29, 2021

cc @laurentheirendt @stelmo

@exaexa
Copy link
Collaborator Author

exaexa commented May 4, 2021

(This tracks state of what is merged in #164)

@exaexa exaexa modified the milestones: Release - v1.0, Release - v1.1 May 11, 2021
@exaexa exaexa linked a pull request Jul 6, 2021 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants