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

Example rework #737

Merged
merged 8 commits into from
Mar 24, 2022
Merged

Example rework #737

merged 8 commits into from
Mar 24, 2022

Conversation

JoshuaFisherC
Copy link
Contributor

Extensive update to entire examples folder to make it more beginner friendly. Also updated deprecated functions in results.py to correctly display a deprecation warning.

Updated Example folder. Example folder much much easier to navigate and understand
Changed all instances of .append in os path to .insert at position 1. Changed as many instances of "solver =" to "algorithm = "
Got rid of deprecated or removed functions calls. Model is precompiled on time comparisons to prevent massive performance hit due to running make each run. Light edits throughout examples folder as well.
@JoshuaFisherC JoshuaFisherC linked an issue Feb 28, 2022 that may be closed by this pull request
@JoshuaFisherC JoshuaFisherC marked this pull request as ready for review February 28, 2022 22:51
Copy link
Contributor

@BryanRumsey BryanRumsey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove all un-used solver imports and commented code

Dask worker space directory shouldn't be pushed up to github.

GillesPy2_photosynthesis_ex.pdf contians an image with a simulation error.

CLE_examples_convergence.ipynb

  • Replace solver=SSACSolver with algorithm=SSA
  • Replace solver=ODECSolver with algorithm=ODE

Events.ipynb

  • Reference to BasicTauHybridSolver in code block 1.
  • Update the note in code block 1 to include TauHybridCSolver as a viable solver for events.

Run GillesPy2 Simulations in Parallel.ipynb

  • Notebook shouldn't contain a port warning.
  • Replace deprecated plot_std_dev_range with plot_mean_stdev.

SBML_Import_Test.ipynb

  • Download link for sbml file is broken. The correct link is https://www.ebi.ac.uk/biomodels/model/download/BIOMD0000000028.2?filename=BIOMD0000000028_url.xml

Variable_SSA_C_Example.ipynb

  • TauHybridCSolver is missing from the notebook docs.
  • The final plot cell contains a simulation error.

hybrid_continuous_species.ipynb

  • Reference to Basic Tau Hybrid Solver in notebook header.
  • Plot contains a simulation error.

DataVisualization.ipynb

  • Remove deprecated function call plot_std_dev_range.
  • Remove deprecated function call plotplotly_std_dev_range.

GeneticToggleSwitch.ipynb

  • Remove the incorrect comment:
#Default solver for model.run() is the VariableSSACSolver. For more information,
# checkout /examples/AdvancedFeatures/Variable_SSA_C_Example.ipynb

Opioid_Model.ipynb

  • Reference to Basic Tau Leaping in notebook header.
  • Reference to deprecated show_labels in notebook docs for Run Model and plot.

Oregonator.ipynb

  • Replace solver=SSACSolver with algorithm=SSA.
  • Replace solver=ODESolver with algorithm=ODE.

TauSolverRunTimeComparison.ipynb

  • initial_condition of V should be set to n in for loop and should work with python and c solvers.
  • Instantiate timing_data as an empty dict.

TauSolverRunTimeComparison.py

  • Needs to be updated to match the notebook or removed.

Michaelis-Menten.ipynb

  • Reference to deprecated show_labels in notebook docs for Run Model and plot.

VilarOscillator.ipynb

  • Reference to deprecated show_labels in notebook docs for Run Model and plot.

ResultsManagement.ipynb

  • Remove warnings import

StartHere.ipynb

  • Remove cell with solver imports

gillespy2/core/results.py Outdated Show resolved Hide resolved
gillespy2/core/results.py Outdated Show resolved Hide resolved
examples/README.md Outdated Show resolved Hide resolved
examples/README.md Outdated Show resolved Hide resolved
examples/README.md Outdated Show resolved Hide resolved
Completed corrections as well as added a simple notebook showcasing model pre compilation within the advancedfeatures folder
gillespy2/core/results.py Outdated Show resolved Hide resolved
gillespy2/core/results.py Outdated Show resolved Hide resolved
@BryanRumsey BryanRumsey self-requested a review March 16, 2022 20:00
Copy link
Contributor

@BryanRumsey BryanRumsey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything looks good to go

@BryanRumsey BryanRumsey added the enhancement New feature or request label Mar 17, 2022
@BryanRumsey BryanRumsey added this to the 1.6.9 milestone Mar 17, 2022
@BryanRumsey BryanRumsey merged commit 4637ca6 into develop Mar 24, 2022
@BryanRumsey BryanRumsey deleted the Example-Rework branch March 24, 2022 19:36
@BryanRumsey BryanRumsey mentioned this pull request Apr 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
4 participants