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.

Sign up for GitHub

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

Jump to bottom

Create Sphinx gallery #46

Closed
briandesilva opened this issue Feb 11, 2020 · 3 comments
Closed

Create Sphinx gallery #46

briandesilva opened this issue Feb 11, 2020 · 3 comments
Assignees
@briandesilva
Labels
enhancement New feature or request priority:high

Comments

@briandesilva
Copy link
Member

We should create a Sphinx gallery so that all our examples are housed in one place on our documentation site.
@briandesilva briandesilva added enhancement New feature or request priority:low labels Feb 11, 2020
@briandesilva briandesilva mentioned this issue Feb 23, 2020
Closed
@briandesilva
Copy link
Member Author

Bumping to high priority since this feature has been requested by @sixpearls in openjournals/joss-reviews#2104.

@briandesilva briandesilva self-assigned this Mar 8, 2020
@briandesilva
Copy link
Member Author

After looking at the available options, I'm thinking that the best way to structure the examples are as follows:

  • feature_overview.ipynb can be included directly on the documentation site via nbsphinx. An interactive version can be hosted on binder and linked in the notebook itself.
  • The examples contained in sindy_paper.ipynb can be split up into separate files and hosted in a sphinx gallery.
  • New examples can be included using either of the above formats, depending on how involved they are.

@briandesilva briandesilva mentioned this issue Mar 9, 2020
Merged
@briandesilva
Copy link
Member Author

Addressed in #57 .

jpcurbelo pushed a commit to jpcurbelo/pysindy_fork that referenced this issue May 9, 2024
@gauchm
Add a GenericDataset that is not specific to any region. (dynamicsla…
3b0624e 
…b#46)

* Add a GenericDataset that is not specific to any region.
This commit introduces GenericDataset that accepts discharge and
forcings for any region as netcdf files, together with csv attribute
files. To implement this, we rename 'camels_attributes' to 'static_attributes'
and (for clarity) 'static_inputs' to 'evolving_attributes'.

* All datasets' attribute loading will fail if a specified basin or attribute is not in the attributes df.
jpcurbelo pushed a commit to jpcurbelo/pysindy_fork that referenced this issue May 9, 2024
@gauchm
release v0.9.6-beta
9c92f0f 
 Add a GenericDataset that is not specific to any region. (dynamicslab#46)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@briandesilva briandesilva

Labels
enhancement New feature or request priority:high
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@briandesilva